Skip to main content

Interface: FeedWriter

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

FeedWriter is an interface for updating feeds

Extends​

Properties​

owner​

readonly owner: EthAddress

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

Inherited from​

FeedReader.owner


topic​

readonly topic: Topic

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

Inherited from​

FeedReader.topic

Methods​

download()​

download(options?): Promise<FeedPayloadResult>

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

Parameters​

options?​

FeedUpdateOptions

Returns​

Promise<FeedPayloadResult>

Deprecated​

Use downloadReference or downloadPayload instead to disambiguate how the data should be interpreted.

Inherited from​

FeedReader.download


downloadPayload()​

downloadPayload(options?): Promise<FeedPayloadResult>

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

Downloads the feed update (latest if no index is specified) and returns it as a payload.

Parameters​

options?​

FeedUpdateOptions

Returns​

Promise<FeedPayloadResult>

Inherited from​

FeedReader.downloadPayload


downloadReference()​

downloadReference(options?): Promise<FeedReferenceResult>

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

Downloads the feed update (latest if no index is specified) and returns it as a reference.

Parameters​

options?​

FeedUpdateOptions

Returns​

Promise<FeedReferenceResult>

Inherited from​

FeedReader.downloadReference


upload()​

upload(postageBatchId, reference, options?): Promise<UploadResult>

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

Upload a new feed update

Parameters​

postageBatchId​

Postage BatchId to be used to upload the data with

string | BatchId

reference​

The reference to be stored in the new update

string | Uint8Array<ArrayBufferLike> | Reference

options?​

FeedUploadOptions

Additional options like at

Returns​

Promise<UploadResult>

UpdateResult that points at Single Owner Chunk that contains the new update and pointer to the updated chunk reference.

Deprecated​

Use uploadReference or uploadPayload instead to disambiguate how the data should be interpreted.


uploadPayload()​

uploadPayload(postageBatchId, payload, options?): Promise<UploadResult>

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

Parameters​

postageBatchId​

string | BatchId

payload​

string | Uint8Array<ArrayBufferLike>

options?​

FeedUploadOptions

Returns​

Promise<UploadResult>


uploadReference()​

uploadReference(postageBatchId, reference, options?): Promise<UploadResult>

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

Parameters​

postageBatchId​

string | BatchId

reference​

string | Uint8Array<ArrayBufferLike> | Reference

options?​

FeedUploadOptions

Returns​

Promise<UploadResult>

💬 Get Help