@maschinenlesbar.org/openka-cli
    Preparing search index...

    Interface SyncPlanOptions

    The part of the sync options that says what a job covers: the window discovery looks at, and which of the Anfragen it finds are handled (issue #27).

    interface SyncPlanOptions {
        apiKey?: string;
        engine: FetchEngine;
        ignoreRobots?: boolean;
        limit?: number;
        metadataOnly?: boolean;
        onlyNew?: boolean;
        period?: number;
        refs?: string[];
        retryFailed?: boolean;
        sample?: number;
        since?: string;
        source: Source;
        store: Pick<
            Store,
            | "getSourceState"
            | "getRecord"
            | "hasRecord"
            | "hasBlob"
            | "blobPath"
            | "loadArtifact"
            | "assertBlobStore",
        >;
        until?: string;
    }

    Hierarchy (View Summary)

    Index
    apiKey? engine ignoreRobots? limit? metadataOnly? onlyNew? period? refs? retryFailed? sample? since? source store until?
    apiKey?: string
    engine: FetchEngine
    ignoreRobots?: boolean
    limit?: number
    metadataOnly?: boolean
    onlyNew?: boolean

    Skip every Anfrage the corpus holds with all its documents, without a request for it; what is missing, or stored without a document, is handled.

    period?: number
    refs?: string[]

    Handle only these references of the window, and the ones they were filed under before (DocRef.formerly). With retryFailed too, either one selects.

    retryFailed?: boolean

    Handle only the Anfragen whose last attempt failed (SourceState.failed).

    sample?: number

    HEAD requests at most for the size estimate (default DRY_RUN_SAMPLE); 0 asks none.

    since?: string
    source: Source
    store: Pick<
        Store,
        | "getSourceState"
        | "getRecord"
        | "hasRecord"
        | "hasBlob"
        | "blobPath"
        | "loadArtifact"
        | "assertBlobStore",
    >

    Read only: records, blobs and source state. Nothing is written.

    until?: string

    Settings
    Member Visibility

    On This Page
    Properties