Interface: CollectionUploadOptions

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

Extends

• UploadOptions

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

---

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

• Bee docs - Store with Encryption
• Bee API reference - POST /bzz
• Reference

Inherited from

UploadOptions.encrypt

---

errorDocument?

optional errorDocument: string

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

Configure custom error document to be returned when a specified path can not be found in collection.

See

• Bee docs - Upload a directory
• Bee API reference - POST /bzz

---

indexDocument?

optional indexDocument: string

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

Default file to be returned when the root hash of collection is accessed.

See

• Bee docs - Upload a directory
• Bee API reference - POST /bzz

---

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

• Bee docs - Pinning
• Bee API reference - POST /bzz

Inherited from

UploadOptions.pin

---

redundancyLevel?

optional redundancyLevel: RedundancyLevel

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

---

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

• Bee API reference - POST /bzz
• Bee docs - Syncing / Tags

Link

Tag

Inherited from

UploadOptions.tag