serverless-dynamo-client
AWS DynamoDB client
This is a wrapper around the official AWS.DynamoDB SDK that:
- Plays nicely with serverless-offline by providing sane default behavior based on
IS_OFFLINE
environment variable. - Looks for the AWS region config in configurable environment variable
Table of Contents
Install
npm install --save serverless-dynamo-client
Usage
var dynamo = const client = dynamo const docClient = dynamo
API
Shared [options]
The following options are shared between the two methods below.
envPrefix
{string} if this is set, DDB will look for config in environment variables prefixed byenvPrefix
.region
{string} if not set, DDB will look in${envPrefix}_REGION
. IfenvPrefix
is not set, it looks atAWS_REGION
. If still not found, when inserverless-offline
mode, it will fall back tolocalhost
endpoint
{string} if inserverless-offline
mode, this defaults tohttp://localhost:8000
sslEnabled
{boolean} defaults totrue
, if inserverless-offline
mode, it is set to false
getClient([options])
options
{Object - shared options above or AWS.DynamoDB standard options}
Method: dynamo.getClient
Creates an AWS.DynamoDB
with provided options.
var dynamo = const docClient = dynamo
getDocumentClient([options])
options
{Object - shared options above or AWS.DynamoDB.DocumentClient standard options}
Method: dynamo.getDocumentClient
Creates an AWS.DynamoDB.DocumentClient
with provided options.
var dynamo = const docClient = dynamo
Contribute
PRs accepted. Note that code uses standard styling.
License
MIT © Dan Caddigan