Documentation
    Preparing search index...

    Interface WriteQuiltOptions

    interface WriteQuiltOptions {
        attributes?: Record<string, string | null>;
        blobs: {
            contents: Uint8Array;
            identifier: string;
            tags?: Record<string, string>;
        }[];
        deletable: boolean;
        epochs: number;
        onStep?: (step: WriteBlobStep) => void | Promise<void>;
        owner?: string;
        resume?: WriteBlobStep;
        signal?: AbortSignal | null;
        signer: Signer;
    }

    Hierarchy

    Index

    Properties

    attributes? blobs deletable epochs onStep? owner? resume? signal? signer

    Properties

    attributes?: Record<string, string | null>

    The attributes to write for the blob.

    blobs: {
        contents: Uint8Array;
        identifier: string;
        tags?: Record<string, string>;
    }[]
    deletable: boolean
    epochs: number

    The number of epochs the blob should be stored for.

    onStep?: (step: WriteBlobStep) => void | Promise<void>

    Called at each pipeline stage with a step result the caller can persist for crash recovery.

    owner?: string

    Where the blob should be transferred to after it is registered. Defaults to the signer address.

    resume?: WriteBlobStep

    Resume from a prior step result. Skips completed stages and resumes from the next one.

    signal?: AbortSignal | null

    An AbortSignal to set request's signal.

    signer: Signer

    Settings

    Member Visibility

    On This Page

    Properties