Class: Tag
Defined in: bee-js/src/modules/tag.ts:13
Tag operations for tracking upload and synchronization progress.
Accessed as bee.tag.
Constructors
Constructor
new Tag(
context):Tag
Defined in: bee-js/src/modules/tag.ts:14
Parameters
context
BeeContext
Returns
Tag
Methods
create()
create(
requestOptions?):Promise<Tag>
Defined in: bee-js/src/modules/tag.ts:21
Creates a new tag which is meant for tracking upload and synchronization progress.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Tag>
delete()
delete(
tagUid,requestOptions?):Promise<void>
Defined in: bee-js/src/modules/tag.ts:57
Deletes a tag.
Parameters
tagUid
UID or tag object to be deleted
number | Tag
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<void>
get()
get(
tagUid,requestOptions?):Promise<Tag>
Defined in: bee-js/src/modules/tag.ts:45
Retrieves tag information from the Bee node.
Parameters
tagUid
UID or tag object to be retrieved
number | Tag
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Tag>
getAll()
getAll(
options?,requestOptions?):Promise<Tag[]>
Defined in: bee-js/src/modules/tag.ts:31
Fetches all tags in a paginated manner.
Parameters
options?
Specify limit and offset to paginate through the tags.
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<Tag[]>
update()
update(
tagUid,reference,requestOptions?):Promise<void>
Defined in: bee-js/src/modules/tag.ts:70
Updates a tag's total chunks count.
Parameters
tagUid
UID or tag object to be updated
number | Tag
reference
The root reference that contains all the chunks to be counted
string | Reference
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<void>