This package wraps the SNS Client - AWS SDK for JavaScript v3 to provide consistent logging and other services.

• wrapped-sns-client
  • static
    • .WrappedSnsClient
      • new exports.WrappedSnsClient([options])
      • instance
        • .createTopic(topicName, [attributes]) ⇒ Promise.<string>
        • .deleteTopic(topicArn) ⇒ Promise.<boolean>
        • .getTopicAttributes(topicArn) ⇒ Promise.<object>
        • .publish(options) ⇒ Promise.<string>
        • .crudOperationHandler(topicArn, [indexToken], [getEntity]) ⇒ function
      • static
        • .decodeMessageAttributes(attributes) ⇒ DecodedMessageAttributes
        • .encodeMessageAttributes(attributes) ⇒ EncodedMessageAttributes
  • inner
    • ~DecodedMessageAttributes : Object.<string, (string|number)>
    • ~EncodedMessageAttributes : Object.<string, object>
    • ~GetEntityCallback ⇒ string

Wraps an AWS SNS client to provide standard logging & services.

Kind: static class of wrapped-sns-client

• .WrappedSnsClient
  • new exports.WrappedSnsClient([options])
  • instance
    • .createTopic(topicName, [attributes]) ⇒ Promise.<string>
    • .deleteTopic(topicArn) ⇒ Promise.<boolean>
    • .getTopicAttributes(topicArn) ⇒ Promise.<object>
    • .publish(options) ⇒ Promise.<string>
    • .crudOperationHandler(topicArn, [indexToken], [getEntity]) ⇒ function
  • static
    • .decodeMessageAttributes(attributes) ⇒ DecodedMessageAttributes
    • .encodeMessageAttributes(attributes) ⇒ EncodedMessageAttributes

WrappedSnsClient constructor.

Param	Type	Description
[options]	object	Options.
[options.logger]	object	Logger instance (default is global console object). Must have info, error & debug methods
[options.logInternals]	boolean	Log AWS client internals (default is false).
[options.config]	object	SNSClientConfig.

Create SNS topic.

Kind: instance method of WrappedSnsClient
Returns: Promise.<string> - Topic ARN.

Param	Type	Description
topicName	string	Topic name.
[attributes]	object	Topic attributes (see reference).

Delete SNS topic.

Kind: instance method of WrappedSnsClient
Returns: Promise.<boolean> - True if successful.

Param	Type	Description
topicArn	string	Topic ARN.

Get SNS topic attributes.

Kind: instance method of WrappedSnsClient
Returns: Promise.<object> - Topic attributes.

Param	Type	Description
topicArn	string	Topic ARN.

Publish message to SNS.

Kind: instance method of WrappedSnsClient
Returns: Promise.<string> - Message ID.

Param	Type	Description
options	object	Publish options.
[options.attributes]	DecodedMessageAttributes	Message attributes.
options.message	object | string	Message content.
[options.messageStructure]	object	Message structure.
[options.phoneNumber]	object	Phone number.
[options.subject]	string	Subject
[options.targetArn]	string	Target ARN
[options.topicArn]	string	Topic ARN

Generate a DynamoDB Streams CRUD Operation Lambda event handler.

Kind: instance method of WrappedSnsClient
Returns: function - Event handler.

Param	Type	Description
topicArn	string	Topic ARN
[indexToken]	string	Index token.
[getEntity]	GetEntityCallback	get entity callback.

Decode message attributes from SNS.

Kind: static method of WrappedSnsClient
Returns: DecodedMessageAttributes - Decoded message attributes.

Param	Type	Description
attributes	EncodedMessageAttributes	Encoded message attributes.

Encode message attributes for SNS.

Kind: static method of WrappedSnsClient
Returns: EncodedMessageAttributes - Encoded message attributes.

Param	Type	Description
attributes	DecodedMessageAttributes	Decoded message attributes.

Kind: inner typedef of wrapped-sns-client

Kind: inner typedef of wrapped-sns-client

Extract entity token from index value.

Kind: inner typedef of wrapped-sns-client
Returns: string - Entity token.

Param	Type	Description
indexValue	string	Index value.

---

See more great templates and other tools on my GitHub Profile!