Class default

Represents a publisher that can publish messages to an SNS topic.

Index

Constructors

Methods

publishOnTopic publishSMS

Constructors

constructor

new default(config?: PublisherConfig): default
Constructs a new instance of the Publisher class.
Parameters
- Optionalconfig: PublisherConfig
  The configuration object for the Publisher.
Returns default
None
- Defined in src/Publisher/Publisher.ts:47

Methods

publishOnTopic

publishOnTopic(
    messageObject: any,
    topic: string,
    additionalProps?: object,
): Promise<undefined | PublishCommandOutput>
Publishes a message on a specified topic.
Parameters
- messageObject: any
  The message object to be published.
- topic: string
  The ARN of the topic to publish the message to.
- OptionaladditionalProps: object
  Additional properties to include in the publish command.
Returns Promise<undefined | PublishCommandOutput>
- A promise that resolves to the response from the publish command.
- Defined in src/Publisher/Publisher.ts:61

publishSMS

publishSMS(
message: string,
phone: string,
): Promise<undefined | PublishCommandOutput>
Publishes a message on a specified topic.
Parameters
- message: string
  The SMS message to publish.
- phone: string
  The phone number to publish the message to.
Returns Promise<undefined | PublishCommandOutput>
- A promise that resolves to the response from the publish command.
- Defined in src/Publisher/Publisher.ts:89