Class SnsStore

constructor

• new SnsStore(options?: SnsStoreOptions): SnsStore

  Parameters

  • options: SnsStoreOptions = {}

  Returns SnsStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): SnsClientLike

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

  Returns SnsClientLike

publish

• publish(
      topicArn: string,
      message: SnsMessage,
      options?: SnsPublishOptions,
  ): Promise<SnsPublishResult>

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

  Parameters

  • topicArn: string
  • message: SnsMessage
  • options: SnsPublishOptions = {}

  Returns Promise<SnsPublishResult>

createTopic

• createTopic(
      name: string,
      attributes?: Record<string, string>,
  ): Promise<string | undefined>

  CreateTopic — create a topic by name. Returns its ARN.

  Parameters

  • name: string
  • Optionalattributes: Record<string, string>

  Returns Promise<string | undefined>

subscribe

• subscribe(
      topicArn: string,
      endpoint: string,
      options?: SnsSubscribeOptions,
  ): Promise<string | undefined>

  Subscribe — register a push endpoint on the topic at topicArn. Unlike poll-based engines, SNS pushes notifications to the endpoint, so this takes an endpoint (SQS/Lambda ARN, HTTPS URL, email, ...) and a protocol rather than a message handler. Returns the subscription ARN (or 'pending confirmation' for endpoints that require confirmation).

  Parameters

  • topicArn: string
  • endpoint: string
  • options: SnsSubscribeOptions = {}

  Returns Promise<string | undefined>