Skip to main content

Class: Stream

A convenience API for managing and accessing an individual stream.

Properties​

id​

readonly id: StreamID

Methods​

Important​

addToStorageNode()​

addToStorageNode(storageNodeAddress, opts): Promise<void>

See StreamrClient.addStreamToStorageNode.

Parameters​
storageNodeAddress​

string

opts​
timeout​

number

wait​

boolean

Returns​

Promise<void>

getPermissions()​

getPermissions(): Promise<PermissionAssignment[]>

See StreamrClient.getPermissions.

Returns​

Promise<PermissionAssignment[]>

grantPermissions()​

grantPermissions(...assignments): Promise<void>

See StreamrClient.grantPermissions.

Parameters​
assignments​

...PermissionAssignment[]

Returns​

Promise<void>

hasPermission()​

hasPermission(query): Promise<boolean>

See StreamrClient.hasPermission.

Parameters​
query​

Omit<UserPermissionQuery, "streamId"> | Omit<PublicPermissionQuery, "streamId">

Returns​

Promise<boolean>

publish()​

publish(content, metadata?): Promise<Message>

See StreamrClient.publish.

Parameters​
content​

unknown

metadata?​

PublishMetadata

Returns​

Promise<Message>

revokePermissions()​

revokePermissions(...assignments): Promise<void>

See StreamrClient.revokePermissions.

Parameters​
assignments​

...PermissionAssignment[]

Returns​

Promise<void>

Other​

getDescription()​

getDescription(): Promise<undefined | string>

Returns​

Promise<undefined | string>

getMetadata()​

getMetadata(): Promise<StreamMetadata>

Returns the metadata of the stream.

Returns​

Promise<StreamMetadata>

getPartitionCount()​

getPartitionCount(): Promise<number>

Returns​

Promise<number>

getStorageDayCount()​

getStorageDayCount(): Promise<undefined | number>

Gets the value of storageDays field

Returns​

Promise<undefined | number>

getStorageNodes()​

getStorageNodes(): Promise<string[]>

See StreamrClient.getStorageNodes.

Returns​

Promise<string[]>

getStreamParts()​

getStreamParts(): Promise<StreamPartID[]>

Returns the partitions of the stream.

Returns​

Promise<StreamPartID[]>

removeFromStorageNode()​

removeFromStorageNode(nodeAddress): Promise<void>

See StreamrClient.removeStreamFromStorageNode.

Parameters​
nodeAddress​

string

Returns​

Promise<void>

setDescription()​

setDescription(description): Promise<void>

Parameters​
description​

string

Returns​

Promise<void>

setMetadata()​

setMetadata(metadata): Promise<void>

Updates the metadata of the stream.

Parameters​
metadata​

StreamMetadata

Returns​

Promise<void>

setStorageDayCount()​

setStorageDayCount(count): Promise<void>

Sets the value of storageDays field

Parameters​
count​

number

Returns​

Promise<void>