filecoin-pin
    Preparing search index...

    Interface UploadExecutionOptions

    interface UploadExecutionOptions {
        contextId?: string;
        ipniValidation?: { enabled?: boolean } & Omit<
            WaitForIpniProviderResultsOptions,
            "onProgress",
        >;
        logger: Logger;
        onProgress?: ProgressEventHandler<
            | {
                data: { retryCount: number };
                type: "ipniProviderResults.retryUpdate";
            }
            | {
                data: { result: true; retryCount: number };
                type: "ipniProviderResults.complete";
            }
            | { data: { error: Error }; type: "ipniProviderResults.failed" }
            | { data: { pieceCid: PieceLink }; type: "onUploadComplete" }
            | { data: { txHash: `0x${string}` | undefined }; type: "onPieceAdded" }
            | { data: { pieceIds: number[] }; type: "onPieceConfirmed" },
        >;
        pieceMetadata?: Record<string, string>;
    }
    Index

    Properties

    contextId? ipniValidation? logger onProgress? pieceMetadata?

    Properties

    contextId?: string

    Optional identifier to help correlate logs.

    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.

    onProgress?: ProgressEventHandler<
        | {
            data: { retryCount: number };
            type: "ipniProviderResults.retryUpdate";
        }
        | {
            data: { result: true; retryCount: number };
            type: "ipniProviderResults.complete";
        }
        | { data: { error: Error }; type: "ipniProviderResults.failed" }
        | { data: { pieceCid: PieceLink }; type: "onUploadComplete" }
        | { data: { txHash: `0x${string}` | undefined }; type: "onPieceAdded" }
        | { data: { pieceIds: number[] }; type: "onPieceConfirmed" },
    >

    Optional umbrella onProgress receiving child progress events.

    pieceMetadata?: Record<string, string>

    Optional metadata to associate with the upload.

    Settings

    Member Visibility

    On This Page

    Properties