node-dynamodb
Advanced tools
Comparing version 0.0.2 to 0.0.3
{ | ||
"name": "node-dynamodb", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
## node-dynamodb [![CircleCI](https://circleci.com/gh/danamajid/node-dynamodb.svg?style=svg&circle-token=ecce8b4678b87c308c3914f63ea9d21cddd27f9a)](https://circleci.com/gh/danamajid/node-dynamodb) | ||
A Mongoose-like API for DynamoDB | ||
A (work-in-progress) Mongoose-like API for DynamoDB | ||
### new DynamoDB() | ||
### DynamoDB | ||
Instantiate DynamoDB. | ||
* `env` - The environment | ||
* `database` - The environment | ||
* `connection` - Object with an instance of `new AWS.DynamoDB` for `db` and `new AWS.DynamoDB.DocumentClient` for `client` | ||
* `logger` - Optional interface that implements `info`, `warn`, `error`, `fatal`, `debug`, `trace` and `child`. | ||
__Example:__ | ||
@@ -22,3 +15,3 @@ | ||
#### DynamoDB.model(name, definition, options) | ||
#### DynamoDB.model(schema, options) | ||
@@ -50,2 +43,7 @@ Define your model. | ||
* `env` - The environment | ||
* `database` - The environment | ||
* `connection` - Object with an instance of `new AWS.DynamoDB` for `db` and `new AWS.DynamoDB.DocumentClient` for `client` | ||
* `logger` - Optional interface that implements `info`, `warn`, `error`, `fatal`, `debug`, `trace` and `child`. | ||
__Example:__ | ||
@@ -93,2 +91,15 @@ | ||
#### Movie.get(details, callback); | ||
GET an item. | ||
__Example:__ | ||
```js | ||
Movie.get({ | ||
year: 2001, | ||
title: 'A Beautiful Mind' | ||
}, done); | ||
``` | ||
#### Author | ||
@@ -95,0 +106,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
22085
114