Class Stream

A convenience API for managing and accessing an individual stream.

Hierarchy

Stream

Index

Important

addToStorageNode getPermissions grantPermissions hasPermission publish revokePermissions

Other

id delete detectFields getMetadata getStorageNodes getStreamParts removeFromStorageNode update

Important

addToStorageNode

addToStorageNode(storageNodeAddress: string, waitOptions?: {
timeout?: number;
}): Promise<void>
Assigns the stream to a storage node.

Returns
a resolved promise if (1) stream was assigned to storage node and (2) the storage node acknowledged the assignment within timeout, otherwise rejects. Notice that is possible for this promise to reject but for the storage node assignment to go through eventually.
Parameters
- storageNodeAddress: string
- waitOptions: {
  timeout?: number;
  } = {}
  
  control how long to wait for storage node to pick up on assignment
  - Optional timeout?: number
Returns Promise<void>

getPermissions

getPermissions(): Promise<PermissionAssignment[]>
See StreamrClient.getPermissions.

Returns Promise<PermissionAssignment[]>

grantPermissions

grantPermissions(...assignments: PermissionAssignment[]): Promise<void>
See StreamrClient.grantPermissions.
Parameters
- Rest ...assignments: PermissionAssignment[]
Returns Promise<void>

hasPermission

hasPermission(query: Omit<UserPermissionQuery, "streamId"> | Omit<PublicPermissionQuery, "streamId">): Promise<boolean>
See StreamrClient.hasPermission.
Parameters
- query: Omit<UserPermissionQuery, "streamId"> | Omit<PublicPermissionQuery, "streamId">
Returns Promise<boolean>

publish

publish(content: unknown, metadata?: PublishMetadata): Promise<Message>
See StreamrClient.publish.
Parameters
- content: unknown
- Optional metadata: PublishMetadata
Returns Promise<Message>

revokePermissions

revokePermissions(...assignments: PermissionAssignment[]): Promise<void>
See StreamrClient.revokePermissions.
Parameters
- Rest ...assignments: PermissionAssignment[]
Returns Promise<void>

Other

`Readonly` id

id: StreamID

delete

delete(): Promise<void>
Deletes the stream.

Remarks
Stream instance should not be used afterwards.

Returns Promise<void>

detectFields

detectFields(): Promise<void>
Attempts to detect and update the config metadata of the stream by performing a resend.

Remarks
Only works on stored streams.

Returns
be mindful that in the case of there being zero messages stored, the returned promise will resolve even though fields were not updated

Returns Promise<void>

getMetadata

getMetadata(): StreamMetadata
Returns the metadata of the stream.

Returns StreamMetadata

getStorageNodes

getStorageNodes(): Promise<string[]>
See StreamrClient.getStorageNodes.

Returns Promise<string[]>

getStreamParts

getStreamParts(): StreamPartID[]
Returns the partitions of the stream.

Returns StreamPartID[]

removeFromStorageNode

removeFromStorageNode(nodeAddress: string): Promise<void>
See StreamrClient.removeStreamFromStorageNode.
Parameters
- nodeAddress: string
Returns Promise<void>

update

update(metadata: Partial<StreamMetadata>): Promise<void>
Updates the metadata of the stream by merging with the existing metadata.
Parameters
- metadata: Partial<StreamMetadata>
Returns Promise<void>

Class Stream

Hierarchy

Index

Important

Other

Important

addToStorageNode

Returns

Parameters

storageNodeAddress: string

waitOptions: { timeout?: number; } = {}

Optional timeout?: number

Returns Promise<void>

getPermissions

Returns Promise<PermissionAssignment[]>

grantPermissions

Parameters

Rest ...assignments: PermissionAssignment[]

Returns Promise<void>

hasPermission

Parameters

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

Returns Promise<boolean>

publish

Parameters

content: unknown

Optional metadata: PublishMetadata

Returns Promise<Message>

revokePermissions

Parameters

Rest ...assignments: PermissionAssignment[]

Returns Promise<void>

Other

Readonly id

delete

Remarks

Returns Promise<void>

detectFields

Remarks

Returns

Returns Promise<void>

getMetadata

Returns StreamMetadata

getStorageNodes

Returns Promise<string[]>

getStreamParts

Returns StreamPartID[]

removeFromStorageNode

Parameters

nodeAddress: string

Returns Promise<void>

update

Parameters

metadata: Partial<StreamMetadata>

Returns Promise<void>

Settings

Member Visibility

Theme

waitOptions: {
timeout?: number;
} = {}

`Optional` timeout?: number

`Rest` ...assignments: PermissionAssignment[]

`Optional` metadata: PublishMetadata

`Rest` ...assignments: PermissionAssignment[]

`Readonly` id