filecoin-pin
    Preparing search index...

    Interface UploadExecutionOptions

    interface UploadExecutionOptions {
        contextId?: string;
        count?: number;
        dataSetIds?: bigint[];
        excludeProviderIds?: bigint[];
        ipniValidation?: { enabled?: boolean } & Omit<
            WaitForIpniProviderResultsOptions,
            "onProgress",
        >;
        logger: Logger;
        metadata?: Record<string, string>;
        onProgress?: ProgressEventHandler<
            | {
                data: {
                    attempt: number;
                    cid: CID;
                    cidAttempt: number;
                    cidCount: number;
                    cidIndex: number;
                    cidMaxAttempts: number;
                    retryCount: number;
                    totalAttempts: number;
                };
                type: "ipniProviderResults.retryUpdate";
            }
            | {
                data: { result: true; retryCount: number };
                type: "ipniProviderResults.complete";
            }
            | { data: { error: Error }; type: "ipniProviderResults.failed" }
            | { data: { pieceCid: PieceLink; providerId: bigint }; type: "onStored" }
            | {
                data: { providerId: bigint; txHash: `0x${string}` };
                type: "onPiecesAdded";
            }
            | {
                data: { dataSetId: bigint; pieceIds: bigint[]; providerId: bigint };
                type: "onPiecesConfirmed";
            }
            | {
                data: { pieceCid: PieceLink; providerId: bigint };
                type: "onCopyComplete";
            }
            | {
                data: { error: Error; pieceCid: PieceLink; providerId: bigint };
                type: "onCopyFailed";
            }
            | {
                data: { pieceCid: PieceLink; providerId: bigint; status: PullStatus };
                type: "onPullProgress";
            }
            | { data: { provider: PDPProvider }; type: "onProviderSelected" }
            | {
                data: { dataSetId: bigint; provider: PDPProvider };
                type: "onDataSetResolved";
            },
        >;
        pieceMetadata?: Record<string, string>;
        providerIds?: bigint[];
        signal?: AbortSignal;
    }
    Index

    Properties

    contextId?: string

    Optional identifier to help correlate logs.

    count?: number

    Number of storage copies to create (default determined by SDK).

    dataSetIds?: bigint[]

    Specific data set IDs to use.

    excludeProviderIds?: bigint[]

    Provider IDs to exclude from selection.

    ipniValidation?: { enabled?: boolean } & Omit<
        WaitForIpniProviderResultsOptions,
        "onProgress",
    >

    Optional IPNI validation behaviour. When enabled (default), the upload flow will wait for the IPFS Root CID to be announced to IPNI.

    Type Declaration

    • Optionalenabled?: boolean

      Enable the IPNI validation wait.

      @default: true

    logger: Logger

    Logger used for structured upload events.

    metadata?: Record<string, string>

    Data set metadata applied when creating or matching contexts.

    onProgress?: ProgressEventHandler<
        | {
            data: {
                attempt: number;
                cid: CID;
                cidAttempt: number;
                cidCount: number;
                cidIndex: number;
                cidMaxAttempts: number;
                retryCount: number;
                totalAttempts: number;
            };
            type: "ipniProviderResults.retryUpdate";
        }
        | {
            data: { result: true; retryCount: number };
            type: "ipniProviderResults.complete";
        }
        | { data: { error: Error }; type: "ipniProviderResults.failed" }
        | { data: { pieceCid: PieceLink; providerId: bigint }; type: "onStored" }
        | {
            data: { providerId: bigint; txHash: `0x${string}` };
            type: "onPiecesAdded";
        }
        | {
            data: { dataSetId: bigint; pieceIds: bigint[]; providerId: bigint };
            type: "onPiecesConfirmed";
        }
        | {
            data: { pieceCid: PieceLink; providerId: bigint };
            type: "onCopyComplete";
        }
        | {
            data: { error: Error; pieceCid: PieceLink; providerId: bigint };
            type: "onCopyFailed";
        }
        | {
            data: { pieceCid: PieceLink; providerId: bigint; status: PullStatus };
            type: "onPullProgress";
        }
        | { data: { provider: PDPProvider }; type: "onProviderSelected" }
        | {
            data: { dataSetId: bigint; provider: PDPProvider };
            type: "onDataSetResolved";
        },
    >

    Optional umbrella onProgress receiving child progress events.

    pieceMetadata?: Record<string, string>

    Optional metadata to associate with the upload (per-piece).

    providerIds?: bigint[]

    Specific provider IDs to use.

    signal?: AbortSignal

    Optional AbortSignal to cancel the upload operation.