Skip to content
Dynamoose is a modeling tool for Amazon's DynamoDB
Branch: master
Clone or download
semantic-release-bot chore(release): 1.7.2 [skip ci]
## [1.7.2](v1.7.1...v1.7.2) (2019-03-18)

### Bug Fixes

* **types:** minor updates to typings ([63bb60d](63bb60d)), closes [#599](#599) [#600](#600)
Latest commit cedea45 Mar 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci(docs): fix deploy branch Mar 10, 2019
.github
docs ci(docs): style issue Mar 10, 2019
internal_tests
lib
project_maintenance Updating guide Dec 1, 2018
test
website/assets docs(rish): pulling in rish homepage styling Feb 27, 2019
.eslintignore
.eslintrc.js
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
README.md
ROADMAP.md
build-docs.js
commitlint.config.js
dynamoose.d.ts fix(types): minor updates to typings Mar 18, 2019
mkdocs.yml ci(docs): fix name Mar 10, 2019
npm-shrinkwrap.json
package.json
release.config.js style(lint): enabling strict rule Feb 17, 2019
travis-deploy
travis-docs ci(docs): deploy docs on master merge Feb 16, 2019
travis-test ci(deployment): setting deployment to only run once Feb 10, 2019
tsconfig.json feat(ts): adding ts testing, compiling and exports Mar 10, 2019
tslint.json

README.md

Dynamoose

Slack Chat Build Status Coverage Status

Dynamoose is a modeling tool for Amazon's DynamoDB (inspired by Mongoose)

Getting Started

Installation

$ npm i dynamoose

Example

Set AWS configurations in environment variables:

export AWS_ACCESS_KEY_ID="Your AWS Access Key ID"
export AWS_SECRET_ACCESS_KEY="Your AWS Secret Access Key"
export AWS_REGION="us-east-1"

Here's a simple example:

const dynamoose = require('dynamoose');

// Create cat model with default options
const Cat = dynamoose.model('Cat', {
  id: Number,
  name: String
});

// Create a new cat object
const garfield = new Cat({
  id: 666,
  name: 'Garfield'
});

// Save to DynamoDB
garfield.save(); // Returns a promise that resolves when save has completed

// Lookup in DynamoDB
Cat.get(666).then((badCat) => {
  console.log(`Never trust a smiling cat. - ${badCat.name}`);
});

API Docs

The documentation can be found at https://dynamoosejs.com/api/about/. You can also find additional examples at https://dynamoosejs.com/examples/about/.

Changelog

The Dynamoose Changelog can be found in the CHANGELOG.md file.

Roadmap

The Dynamoose Roadmap can be found in the ROADMAP.md file. Help is always appreciated on these items. If you are able to help submit a PR so we can review and improve Dynamoose!

Contributing

To contirubute to this project please checkout our CONTRIBUTING.md file.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.