Skip to main content

Interface: FileUploadOptions

Defined in: bee-js/src/types/index.ts:200

Extends​

Properties​

act?​

optional act: boolean

Defined in: bee-js/src/types/index.ts:101

If set to true, an ACT will be created for the uploaded data.

Inherited from​

UploadOptions.act

actHistoryAddress?​

optional actHistoryAddress: string | Uint8Array<ArrayBufferLike> | Reference

Defined in: bee-js/src/types/index.ts:103

Inherited from​

UploadOptions.actHistoryAddress

contentType?​

optional contentType: string

Defined in: bee-js/src/types/index.ts:213

Specifies given Content-Type so when loaded in browser the file is correctly represented.

See​

Bee API reference - POST /bzz

deferred?​

optional deferred: boolean

Defined in: bee-js/src/types/index.ts:143

Determines if the uploaded data should be sent to the network immediately (eq. deferred=false) or in a deferred fashion (eq. deferred=true).

With deferred style client uploads all the data to Bee node first and only then Bee node starts push the data to network itself. The progress of this upload can be tracked with tags. With non-deferred style client uploads the data to Bee which immediately starts pushing the data to network. The request is only finished once all the data was pushed through the Bee node to the network.

In future there will be move to the non-deferred style and even the support for deferred upload will be removed from Bee itself.

Default​

true

Inherited from​

UploadOptions.deferred

encrypt?​

optional encrypt: boolean

Defined in: bee-js/src/types/index.ts:122

Will encrypt the uploaded data and return longer hash which also includes the decryption key.

See​

Inherited from​

UploadOptions.encrypt

pin?​

optional pin: boolean

Defined in: bee-js/src/types/index.ts:113

Will pin the data locally in the Bee node as well.

Locally pinned data is possible to reupload to network if it disappear.

See​

Inherited from​

UploadOptions.pin

redundancyLevel?​

optional redundancyLevel: RedundancyLevel

Defined in: bee-js/src/types/index.ts:215

size?​

optional size: number

Defined in: bee-js/src/types/index.ts:206

Specifies Content-Length for the given data. It is required when uploading with Readable.

See​

Bee API reference - POST /bzz

tag?​

optional tag: number

Defined in: bee-js/src/types/index.ts:131

Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data.

See​

Tag

Inherited from​

UploadOptions.tag

💬 Get Help