Skip to content

kbrashears5/typescript-aws-sqs-helper

Repository files navigation

typescript-aws-sqs-helper

Typescript helper functions for AWS SQS service

CI/CD codecov NPM Version Downloads

Install

npm install typescript-aws-sqs-helper@latest

Usage

Default - running in Lambda in your own account

const logger = new Logger(LogLevel.Trace);

const helper = new SQSHelper(logger);

const response = await helper.DeleteMessageAsync('queueUrl', 'receiptHandle');

Running in separate account or not in Lambda

import * as SQS from '@aws-sdk/client-sqs';

const logger = new Logger(LogLevel.Trace);

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

const repository = new SQS.SQS(options);

const helper = new SQSHelper(logger, repository);

const response = await helper.DeleteMessageAsync('queueUrl', 'receiptHandle');

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