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
- Usage
- Contribute
- License

Install

``bash
npm install --save serverless-dynamo-client
`

Usage

`javascript
var dynamo = require('serverless-dynamo-client')

const client = dynamo.getClient({
envPrefix: 'AWS_DDB',
maxRetries: 3
})

const docClient = dynamo.getDocumentClient({
convertEmptyValues: true
})
`

API

$3

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 localhost
* endpoint {string} if in serverless-offline mode, this defaults to http://localhost:8000
* sslEnabled {boolean} defaults to true, if in serverless-offline mode, it is set to false

$3

* options {Object - shared options above or AWS.DynamoDB standard options}

$3

Creates an AWS.DynamoDB with provided options.

`javascript
var dynamo = require('serverless-dynamo-client')

const docClient = dynamo.getClient({
envPrefix: 'AWS_DDB',
maxRetries: 3
})
`

$3

* options {Object - shared options above or AWS.DynamoDB.DocumentClient standard options}

$3

Creates an AWS.DynamoDB.DocumentClient with provided options.

`javascript
var dynamo = require('serverless-dynamo-client')

const docClient = dynamo.getDocumentClient({
convertEmptyValues: true
})
``

Contribute

PRs accepted. Note that code uses standard styling.

License

MIT © Dan Caddigan