DynamoDB client that plays nicely with serverless-offline and serverless-dynamodb-local
npm install serverless-dynamo-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
- Install
- Usage
- Contribute
- License
``bash`
npm install --save serverless-dynamo-client
`javascript
var dynamo = require('serverless-dynamo-client')
const client = dynamo.getClient({
envPrefix: 'AWS_DDB',
maxRetries: 3
})
const docClient = dynamo.getDocumentClient({
convertEmptyValues: true
})
`
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 by envPrefix.region
* {string} if not set, DDB will look in ${envPrefix}_REGION. If envPrefix is not set, it looks at AWS_REGION
. If still not found, when in serverless-offline mode, it will fall back to localhostendpoint
* {string} if in serverless-offline mode, this defaults to http://localhost:8000sslEnabled
* {boolean} defaults to true, if in serverless-offline mode, it is set to false
* options {Object - shared options above or AWS.DynamoDB standard options}
Creates an AWS.DynamoDB with provided options.
`javascript
var dynamo = require('serverless-dynamo-client')
const docClient = dynamo.getClient({
envPrefix: 'AWS_DDB',
maxRetries: 3
})
`
* options {Object - shared options above or AWS.DynamoDB.DocumentClient standard options}
Creates an AWS.DynamoDB.DocumentClient with provided options.
`javascript
var dynamo = require('serverless-dynamo-client')
const docClient = dynamo.getDocumentClient({
convertEmptyValues: true
})
``
PRs accepted. Note that code uses standard styling.
MIT © Dan Caddigan