Interface IPubSubTopic<T>

The pub/sub topic interface.

interface IPubSubTopic<T> {
    subscribe: SubscribeFunction<T>;
    close(): void;
    getName(): string;
    getOwnerId(): string;
    publish(content: File | T, nodeIds?: string[]): void;
    unsubscribe(contentType: keyof ISubscriptions<T>): void;
}

Type Parameters

T

Hierarchy (view full)

IDataStream
- IPubSubTopic

Index

Properties

Methods

close getName getOwnerId publish unsubscribe

Properties

subscribe

subscribe: SubscribeFunction<T>

Subscribe to the topic.

Type Param: U

Any of the content types defined in ISubscriptions.

Param: contentType

One of the content type defined in ISubscriptions.

Param: callback

The callback when the content is received. callbacks' payload are defined in ISubscriptions.

Methods

close

close(): void
Close the topic.

Returns void

getName

getName(): string
Get the name of the topic.

Returns string
Overrides IDataStream.getName

getOwnerId

getOwnerId(): string
Get the owner ID of the topic.

Returns string
Overrides IDataStream.getOwnerId

publish

publish(content, nodeIds?): void
Publish content to the topic.
Parameters
- content: File | T
  The content to publish. Content needs to be a valid JSON.stringify argument.
- OptionalnodeIds: string[]
  The node IDs to publish to.
Returns void

unsubscribe

unsubscribe(contentType): void
Unsubscribe from the topic.
Parameters
- contentType: keyof ISubscriptions<T>
Returns void