README.md

typescript-aws-sns-helper

Typescript helper functions for AWS SNS service

Install

npm install typescript-aws-sns-helper@latest

Usage

Default - running in Lambda in your own account

const logger = new Logger(LogLevel.Trace);

const helper = new SNSHelper(logger);

const response = await helper.PublishAsync('topic', 'subject', 'message');

Running in separate account or not in Lambda

import * as SNS from '@aws-sdk/client-sns';

const logger = new Logger(LogLevel.Trace);

const options: SNS.SNSClientConfig = {
  accessKeyId: '{access_key}',
  secretAccessKey: '{secret_key}',
  region: 'us-east-1',
};

const repository = new SNS.SNS(options);

const helper = new SNSHelper(logger, repository);

const response = await helper.PublishAsync('topic', 'subject', 'message');

Notes

If no options are supplied, will default to us-east-1 as the region

Development

Clone the latest and run

npm run prep

to install packages and prep the git hooks