Class Stream

Hierarchy

Stream

Index

Properties

Methods - Important

addToStorageNode getPermissions grantPermissions hasPermission publish removeFromStorageNode revokePermissions

Methods - Other

delete detectFields getMetadata getStorageNodes getStreamParts update

Properties

`Readonly` id

Important Methods

addToStorageNode

addToStorageNode(nodeAddress: string, waitOptions?: {
timeout?: number;
}): Promise<void>
Parameters
- nodeAddress: string
- waitOptions: {
  timeout?: number;
  } = {}
  - Optional timeout?: number
Returns Promise<void>

getPermissions

getPermissions(): Promise<PermissionAssignment[]>
Returns Promise<PermissionAssignment[]>

grantPermissions

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

hasPermission

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

publish

publish<T>(content: T, metadata?: PublishMetadata): Promise<Message>
Type Parameters
- T
Parameters
- content: T
- Optional metadata: PublishMetadata
Returns Promise<Message>

removeFromStorageNode

removeFromStorageNode(nodeAddress: string): Promise<void>
Parameters
- nodeAddress: string
Returns Promise<void>

revokePermissions

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

Other Methods

delete

delete(): Promise<void>
Returns Promise<void>

detectFields

detectFields(): Promise<void>
Returns Promise<void>

getMetadata

getMetadata(): StreamMetadata
Returns StreamMetadata

getStorageNodes

getStorageNodes(): Promise<string[]>
Returns Promise<string[]>

getStreamParts

getStreamParts(): StreamPartID[]
Returns StreamPartID[]

update

update(metadata: Partial<StreamMetadata>): Promise<void>
Persist stream metadata updates.
Parameters
- metadata: Partial<StreamMetadata>
Returns Promise<void>

Generated using TypeDoc