filecoin-pin
    Preparing search index...

    Interface CheckIpniIndexerOptions

    interface CheckIpniIndexerOptions {
        childBlocks?: CID<unknown, number, number, Version>[];
        delayMs?: number;
        expectedProviders?: PDPProvider[];
        ipniIndexerUrl: string;
        logger?: Logger;
        maxAttempts?: number;
        onProgress?: ProgressEventHandler<ValidateIPNIProgressEvents>;
        signal?: AbortSignal;
    }
    Index
    childBlocks? delayMs? expectedProviders? ipniIndexerUrl logger? maxAttempts? onProgress? signal?
    childBlocks?: CID<unknown, number, number, Version>[]

    Child blocks that must also be validated against expected providers.

    delayMs?: number

    delay between attempts in milliseconds

    @default: 5000

    expectedProviders?: PDPProvider[]

    Providers that are expected to appear in the IPNI provider results. All providers supplied here must be present in the response for the validation to succeed. When omitted or empty, the validation when the IPNI response is non-empty.

    @default: []

    ipniIndexerUrl: string

    IPNI indexer URL to query for provider records. Required — this function has no way to know whether it's safe to poll the given indexer patiently (e.g. cid.contact negative-caches misses for minutes, see content-routing-faq.md), so callers must decide explicitly rather than inherit a default that may not fit their situation.

    logger?: Logger

    Logger instance

    @default: undefined

    maxAttempts?: number

    maximum number of attempts

    @default: 20

    onProgress?: ProgressEventHandler<ValidateIPNIProgressEvents>

    Callback for progress updates

    @default: undefined

    signal?: AbortSignal

    Abort signal

    @default: undefined

    Settings
    Member Visibility

    On This Page
    Properties