Interface: UploadOptions
Defined in: bee-js/src/types/index.ts:97
Extended by
Properties
act?
optionalact:boolean
Defined in: bee-js/src/types/index.ts:101
If set to true, an ACT will be created for the uploaded data.
actHistoryAddress?
optionalactHistoryAddress:string|Uint8Array<ArrayBufferLike> |Reference
Defined in: bee-js/src/types/index.ts:103
deferred?
optionaldeferred: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
encrypt?
optionalencrypt: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
pin?
optionalpin: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
tag?
optionaltag: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
Link
Tag