filecoin-pin
    Preparing search index...

    Interface SynapseUploadOptions

    interface SynapseUploadOptions {
        contextId?: string;
        count?: number;
        dataSetIds?: bigint[];
        excludeProviderIds?: bigint[];
        metadata?: Record<string, string>;
        onProgress?: ProgressEventHandler<UploadProgressEvents>;
        pieceMetadata?: Record<string, string>;
        providerIds?: bigint[];
        signal?: AbortSignal;
    }
    Index

    Properties

    contextId? count? dataSetIds? excludeProviderIds? metadata? onProgress? pieceMetadata? providerIds? signal?

    Properties

    contextId?: string

    Context identifier for logging (e.g., pinId, import job ID)

    count?: number

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

    dataSetIds?: bigint[]

    Specific data set IDs to use (mutually exclusive with providerIds).

    excludeProviderIds?: bigint[]

    Provider IDs to exclude from selection.

    metadata?: Record<string, string>

    Data set metadata applied when creating or matching contexts.

    onProgress?: ProgressEventHandler<UploadProgressEvents>

    Optional callbacks for monitoring upload progress

    pieceMetadata?: Record<string, string>

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

    providerIds?: bigint[]

    Specific provider IDs to use (mutually exclusive with dataSetIds).

    signal?: AbortSignal

    Optional AbortSignal to cancel the upload operation.

    Settings

    Member Visibility

    On This Page

    Properties