Class PubSubStore

constructor

• new PubSubStore(options?: PubSubStoreOptions): PubSubStore

  Parameters

  • options: PubSubStoreOptions = {}

  Returns PubSubStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): PubSubClientLike

  Returns the underlying PubSub client for anything not wrapped here.

  Returns PubSubClientLike

publish

• publish(
      topic: string,
      message: PubSubMessage,
      attributes?: Record<string, string>,
  ): Promise<string>

  Publish one message to topic via topic(name).publishMessage. The message is encoded per the module's rules (string → UTF-8, Buffer → as-is, else JSON). Returns the server-assigned message id.

  Parameters

  • topic: string
  • message: PubSubMessage
  • Optionalattributes: Record<string, string>

  Returns Promise<string>

createTopic

• createTopic(name: string): Promise<void>

  createTopic — create a new topic.

  Parameters

  • name: string

  Returns Promise<void>

createSubscription

• createSubscription(
      topic: string,
      name: string,
      options?: unknown,
  ): Promise<void>

  createSubscription — attach a new subscription name to topic.

  Parameters

  • topic: string
  • name: string
  • Optionaloptions: unknown

  Returns Promise<void>

subscribe

• subscribe(
      subscription: string,
      handler: (message: any) => void | Promise<void>,
  ): Promise<PubSubSubscription>

  Subscribe to subscription, invoking handler for each streamed message (the driver's Message object; call .ack() / .nack() on it). Attaches a 'message' listener via subscription(name).on('message', ...) and returns a subscription handle whose stop() detaches the listener; it is also tracked so disconnect() detaches it.

  Parameters

  • subscription: string
  • handler: (message: any) => void | Promise<void>

  Returns Promise<PubSubSubscription>