typescript-aws-dynamo-helper

Typescript helper functions for AWS Dynamo DB service

Install

npm install typescript-aws-dynamo-helper@latest

Usage

Default - running in Lambda in your own account

const logger = new Logger(LogLevel.Trace);

const helper = new DynamoHelper(logger);

const response = await helper.GetItemByKeyAsync(
  'tableName',
  'keyName',
  'keyValue',
);

Running in separate account or not in Lambda

import * as DynamoDB from '@aws-sdk/client-dynamodb';

const logger = new Logger(LogLevel.Trace);

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

const repository = new DynamoDB.DynamoDB(options);

const helper = new DynamoHelper(logger, repository);

const response = await helper.GetItemByKeyAsync(
  'tableName',
  'keyName',
  'keyValue',
);

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