Class RedisMessageBus<UseBuffer, R>

constructor

• new RedisMessageBus<UseBuffer, R>(client, useBuffer?, defaultTopic?): RedisMessageBus<UseBuffer, R>

• Type Parameters

  • UseBuffer extends boolean = false

  • R extends RedisClientType = RedisClientType

  Parameters

  • client: R

    Redis client to use.

  • Optional useBuffer: UseBuffer

    Whether to use buffers for messages.

  • defaultTopic: string = DEFAULT_TOPIC

    The default topic to publish to.

  Returns RedisMessageBus<UseBuffer, R>

Readonly defaultTopic

started

• get started(): boolean

• Returns if this has started.

  Returns boolean

close

• close(): Promise<void>

• Closes this object and releases any system resource associated with it.

  Returns Promise<void>

dispatch

• dispatch(message, options?): Promise<void>

• Dispatches a message.

  Parameters

  • message: RedisValueType<UseBuffer>

  • Optional options: MessageOptions

  Returns Promise<void>

start

• start(): Promise<void>

• Starts this component.

  Returns Promise<void>

subscribe

• subscribe(handler, options?): Promise<Unsubscribe>

• Subscribes to new messages and returns a handle to unsubscribe.

  Parameters

  • handler: MessageHandler<RedisValueType<UseBuffer>>

  • Optional options: SubscribeOptions<RedisValueType<UseBuffer>, object>

  Returns Promise<Unsubscribe>

topics

• topics(options?): Promise<string[]>

• Returns the list of subscribed topics for this node.

  Parameters

  • Optional options: AbortOptions

  Returns Promise<string[]>