Class Relay<C>Experimental

constructor

• new Relay<C = ConnectionOptions>(opts: RelayOptions<C>): Relay<C>
  Experimental

  Type Parameters

  • C = ConnectionOptions

  Parameters

  • opts: RelayOptions<C>

  Returns Relay<C>

Readonly Experimentalnamespace

Readonly ExperimentalnodeId

close

• close(): Promise<void>
  Experimental

  Stops this node and unregisters it, removing its subscriptions.

  Returns Promise<void>

deleteRetained

• deleteRetained(topic: string): Promise<boolean>
  Experimental

  Deletes the retained message of a topic: new subscribers no longer get it. Returns false if the topic had no retained message.

  Parameters

  • topic: string

  Returns Promise<boolean>

getCounts

• getCounts(): Promise<RelayCounts>
  Experimental

  Totals of this namespace, for dashboards.

  Returns Promise<RelayCounts>

getNamespaces

• getNamespaces(): Promise<string[]>
  Experimental

  Namespaces in use in the datastore (or Redis prefix).

  Returns Promise<string[]>

getNodeConnections

• getNodeConnections(nodeId?: string): Promise<RelayNodeConnection[]>
  Experimental

  A node's inbox connection (this node's by default), as the datastore sees it: its address and how long it has been open and idle. Empty when the node isn't connected. Lists every client of the datastore: use it on demand, not on a timer.

  Parameters

  • nodeId: string = ...

  Returns Promise<RelayNodeConnection[]>

getNodes

• getNodes(start?: number, end?: number): Promise<RelayNodeState[]>
  Experimental

  Nodes of this namespace, in registration order. start and end are inclusive positions; an end of -1 means "to the end".

  Parameters

  • start: number = 0
  • end: number = -1

  Returns Promise<RelayNodeState[]>

getPatterns

• getPatterns(start?: number, end?: number): Promise<RelayPatternState[]>
  Experimental

  Subscribed patterns, ordered by pattern, with their subscriptions.

  Parameters

  • start: number = 0
  • end: number = -1

  Returns Promise<RelayPatternState[]>

getRetained

• getRetained(start?: number, end?: number): Promise<RelayRetainedState[]>
  Experimental

  Retained messages, by expiry (the data is as serialized).

  Parameters

  • start: number = 0
  • end: number = -1

  Returns Promise<RelayRetainedState[]>

getSubscriptions

• getSubscriptions(
      filter?: RelaySubscriptionFilter,
      start?: number,
      end?: number,
  ): Promise<RelaySubscriptionState[]>
  Experimental

  Subscriptions of this namespace (or of a node or pattern only), ordered by node and endpoint (or pattern), then pattern (or node and endpoint).

  Parameters

  • Optionalfilter: RelaySubscriptionFilter
  • start: number = 0
  • end: number = -1

  Returns Promise<RelaySubscriptionState[]>

publish

• publish(
      topic: string,
      data: unknown,
      opts?: RelayPublishOpts,
  ): Promise<RelayPublishResult>
  Experimental

  Publishes data (any JSON-serializable value) on a concrete topic.

  Parameters

  • topic: string
  • data: unknown
  • opts: RelayPublishOpts = {}

  Returns Promise<RelayPublishResult>

subscribe

• subscribe<T = unknown>(
      pattern: string,
      listener: RelayListener<T>,
  ): Promise<RelaySubscription>
  Experimental

  Subscribes to a topic or pattern. For an exact topic, its retained message (if any) is delivered first, with retained: true.

  Type Parameters

  • T = unknown

  Parameters

  • pattern: string
  • listener: RelayListener<T>

  Returns Promise<RelaySubscription>

waitUntilReady

• waitUntilReady(): Promise<void>
  Experimental

  Returns Promise<void>