Interface UploadDirectoryOptions

Hierarchy

Properties

concurrentRequests? connection? customOrder? fetch? fetchWithUploadProgress? onDirectoryEntryLink? onShardStored? onUploadProgress? pieceHasher? retries? rootCID? shardSize? signal?

Properties

Optional concurrentRequests

concurrentRequests?: number

The number of concurrent requests to store shards. Default 3.

Optional connection

connection?: ConnectionView<Service>

Optional customOrder

customOrder?: boolean

whether the directory files have already been ordered in a custom way. indicates that the upload must not use a different order than the one provided.

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      Returns Promise<Response>

Optional fetchWithUploadProgress

fetchWithUploadProgress?: FetchWithUploadProgress

Optional onDirectoryEntryLink

onDirectoryEntryLink?: ((link) => void)

Type declaration

    • (link): void

    • Callback for every DAG encoded directory entry, including the root.

      Parameters

      Returns void

Optional onShardStored

onShardStored?: ((meta) => void)

Type declaration

Optional onUploadProgress

onUploadProgress?: ProgressFn

Optional pieceHasher

pieceHasher?: MultihashHasher<MulticodecCode<4113, "fr32-sha2-256-trunc254-padded-binary-tree">>

Optional retries

retries?: number

Optional rootCID

rootCID?: AnyLink

The root CID of the DAG contained in the shards. By default The last block is assumed to be the DAG root and becomes the CAR root CID for the last CAR output. Set this option to use this CID instead.

Optional shardSize

shardSize?: number

The target shard size. Actual size of CAR output may be bigger due to CAR header and block encoding data.

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc