Class SqsStore

constructor

• new SqsStore(options?: SqsStoreOptions): SqsStore

  Parameters

  • options: SqsStoreOptions = {}

  Returns SqsStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): SqsClientLike

  Returns the underlying SQSClient (loosely typed) for anything not wrapped here.

  Returns SqsClientLike

publish

• publish(
      queueUrl: string,
      message: SqsMessage,
      options?: SendMessageOptions,
  ): Promise<SendMessageResult>

  SendMessage — publish one message to the queue at queueUrl. The message is encoded to a string body (string as-is, Buffer → UTF-8, else JSON). Returns the message id (and FIFO sequence number, if any).

  Parameters

  • queueUrl: string
  • message: SqsMessage
  • options: SendMessageOptions = {}

  Returns Promise<SendMessageResult>

createQueue

• createQueue(
      name: string,
      options?: CreateQueueOptions,
  ): Promise<string | undefined>

  CreateQueue — create a queue by name. Returns its URL.

  Parameters

  • name: string
  • options: CreateQueueOptions = {}

  Returns Promise<string | undefined>

createTopic

• createTopic(
      name: string,
      options?: CreateQueueOptions,
  ): Promise<string | undefined>

  Alias for createQueue(), matching the common store surface.

  Parameters

  • name: string
  • options: CreateQueueOptions = {}

  Returns Promise<string | undefined>

subscribe

• subscribe(
      queueUrl: string,
      handler: (message: any) => void | Promise<void>,
      options?: SqsSubscribeOptions,
  ): SqsSubscription

  Subscribe to the queue at queueUrl: long-poll ReceiveMessage in a loop, invoke handler once per message, and (by default) DeleteMessage to ack each message after the handler resolves. Returns a subscription whose stop() ends the loop; the subscription is tracked so disconnect() stops it. The loop runs detached (not awaited); this method resolves immediately.

  Parameters

  • queueUrl: string
  • handler: (message: any) => void | Promise<void>
  • options: SqsSubscribeOptions = {}

  Returns SqsSubscription