Skip to main content

Interface: UploadOptions

types.UploadOptions

Hierarchy

Properties

concurrentRequests

Optional concurrentRequests: number

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

Inherited from

ShardStoringOptions.concurrentRequests

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:158


connection

Optional connection: ConnectionView<Service>

Inherited from

ShardStoringOptions.connection

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:124


onShardStored

Optional onShardStored: (meta: CARMetadata) => void

Type declaration

▸ (meta): void

Parameters
NameType
metaCARMetadata
Returns

void

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:161


retries

Optional retries: number

Inherited from

ShardStoringOptions.retries

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:118


rootCID

Optional 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.

Inherited from

ShardingOptions.rootCID

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:152


shardSize

Optional shardSize: number

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

Inherited from

ShardingOptions.shardSize

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:146


signal

Optional signal: AbortSignal

Inherited from

ShardStoringOptions.signal

Defined in

node_modules/@web3-storage/upload-client/dist/src/types.d.ts:121