Class: Feed
Defined in: bee-js/src/modules/feed.ts:17
Feed operations.
Accessed as bee.feed. Delegates to the feed subsystem (src/feed).
Constructors
Constructor
new Feed(
context):Feed
Defined in: bee-js/src/modules/feed.ts:18
Parameters
context
BeeContext
Returns
Feed
Methods
createManifest()
createManifest(
postageBatchId,topic,owner,options?,requestOptions?):Promise<Reference>
Defined in: bee-js/src/modules/feed.ts:69
Creates a feed manifest chunk and returns the reference to it.
Parameters
postageBatchId
Postage BatchId to be used to create the Feed Manifest
string | Uint8Array<ArrayBufferLike> | BatchId
topic
Topic in hex or bytes
string | Uint8Array<ArrayBufferLike> | Topic
owner
Owner's ethereum address in hex or bytes
string | Uint8Array<ArrayBufferLike> | EthAddress
options?
Options that affect the request behavior
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Reference>
fetchLatestUpdate()
fetchLatestUpdate(
topic,owner,requestOptions?):Promise<FeedPayloadResult>
Defined in: bee-js/src/modules/feed.ts:100
Fetches the latest feed update.
Parameters
topic
Topic in hex or bytes
string | Uint8Array<ArrayBufferLike> | Topic
owner
Owner's ethereum address in hex or bytes
string | Uint8Array<ArrayBufferLike> | EthAddress
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<FeedPayloadResult>
isRetrievable()
isRetrievable(
owner,topic,index?,options?,requestOptions?):Promise<boolean>
Defined in: bee-js/src/modules/feed.ts:121
Validates whether a feed is retrievable in the network.
Parameters
owner
Owner's ethereum address in hex or bytes
string | Uint8Array<ArrayBufferLike> | EthAddress
topic
Topic in hex or bytes
string | Uint8Array<ArrayBufferLike> | Topic
index?
Optional feed index
options?
Download options
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<boolean>
makeReader()
makeReader(
topic,owner,requestOptions?):FeedReader
Defined in: bee-js/src/modules/feed.ts:27
Makes a new feed reader for downloading feed updates.
Parameters
topic
Topic in hex or bytes
string | Uint8Array<ArrayBufferLike> | Topic
owner
Owner's ethereum address in hex or bytes
string | Uint8Array<ArrayBufferLike> | EthAddress
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
makeWriter()
makeWriter(
topic,signer?,requestOptions?):FeedWriter
Defined in: bee-js/src/modules/feed.ts:46
Makes a new feed writer for updating feeds.
Parameters
topic
Topic in hex or bytes
string | Uint8Array<ArrayBufferLike> | Topic
signer?
The signer's private key. Falls back to the Bee instance signer.
string | Uint8Array<ArrayBufferLike> | PrivateKey
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.