Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.11 KB

README.md

File metadata and controls

35 lines (22 loc) · 1.11 KB
Raw

dynamodb-local

A wrapper for AWS DynamoDB Local, intended for use in testcases. Will automatically download the files needed to run DynamoDb Local.

You can optionally override the download URL from where it fetches the installation archive as well as the target directory to which it will install the binaries (default is your system's temp folder).

Usage

Install the module as development dependency by running

npm install dynamodb-local --save-dev

Then in node, write your test script like this:

var DynamoDbLocal = require('dynamodb-local');
var dynamoLocalPort = 8000;

DynamoDbLocal.launch(dynamoLocalPort, null, ['-sharedDb']) //if you want to share with Javascript Shell
    .then(function () {
    
        // do your tests
        
        DynamoDbLocal.stop(dynamoLocalPort);
    });

Another example which also shows how to override the installer configuration can be found in examples/simple.js.

See AWS DynamoDB Docs for more info on how to interact with DynamoDB Local.