Interface MessageSubscriptionState<Peer>

Message subscription state.

interface MessageSubscriptionState {
subscribers(options?): MaybePromise<Iterable<Peer>>;
topics(options?): MaybePromise<Iterable<string>>;
}

Type Parameters

Peer = unknown

Hierarchy

MessageSubscriptionTopics
MessageSubscriptionPeers<Peer>
- MessageSubscriptionState
  - PeerAwareMessageBus

Index

Methods

subscribers topics

Methods

subscribers

subscribers(options?): MaybePromise<Iterable<Peer>>
Returns the list of peers that are subscribed to a topic.
Parameters
- Optional options: MessageOptions
Returns MaybePromise<Iterable<Peer>>
Inherited from MessageSubscriptionPeers.subscribers
- Defined in packages/messaging/src/peer-aware.ts:25

topics

topics(options?): MaybePromise<Iterable<string>>
Returns the list of subscribed topics for this node.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<Iterable<string>>
Inherited from MessageSubscriptionTopics.topics
- Defined in packages/messaging/src/peer-aware.ts:19

Generated using TypeDoc