issue_tree
    Preparing search index...

    Interface ScanOptions

    Options for a scan run.

    interface ScanOptions {
        cachePath: string;
        client: GithubClient;
        onProgress?: (event: ScanProgress) => void;
        targets: string[];
        wait?: boolean;
    }
    Index

    Properties

    cachePath client onProgress? targets wait?

    Properties

    cachePath: string

    Path to the JSON cache file (read on entry, rewritten between phases).

    client: GithubClient

    GraphQL client used for every GitHub call this scan performs.

    onProgress?: (event: ScanProgress) => void

    Optional progress sink. The CLI wires this to a stderr writer unless --quiet is set.

    targets: string[]

    "owner/repo" pairs to scan

    wait?: boolean

    When true, sleep until the rate limit resets and continue, instead of stopping to be resumed later.

    Settings

    Member Visibility

    On This Page

    Properties