Skip to content

Commit

Permalink
--amend
Browse files Browse the repository at this point in the history
  • Loading branch information
kayomarz committed Jul 10, 2016
1 parent 89ac6dc commit 5bb4c7a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 18 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
[![Build Status](https://travis-ci.org/kayomarz/dynamodb-data-types.svg)](https://travis-ci.org/kayomarz/dynamodb-data-types)
[![Coverage Status](https://coveralls.io/repos/kayomarz/dynamodb-data-types/badge.svg?branch=master&service=github)](https://coveralls.io/github/kayomarz/dynamodb-data-types?branch=master)

This utility helps represent AWS DynamoDb data types. It maps (marshalls)
JavaScript data into the format required by DynamoDb.
This utility helps represent AWS DynamoDb data types. It converts
JavaScript objects into objects as required by DynamoDb.

For example, following is some JavaScript data:

```js
var data = {
fruit: 'Banana',
var data = {
fruit: 'Apple',
count: 12
}
```
Expand All @@ -20,20 +20,15 @@ The DynamoDB SDK requires it to be represented as:
```json
{
"fruit": {
"S": "Banana"
"S": "Apple"
},
"count": {
"N": "12"
}
}
```

This library helps doing that.

Use `wrap` to map (marshall) data into the format required by DynamoDB's
`AttributeValue`.

Use `unwrap` to unmarshall data received from DynamoDB.
Use `wrap` and `unwrap` to convert objects form one form into the other.

## Quick Example

Expand Down Expand Up @@ -647,8 +642,10 @@ version 2.x. See

## Version 3.0.0

+ Only for browser versions of this library ([dist](dist) `Buffer` related code
is excluded.
+ For Node users, version `3.0.0` is identical to `2.1.6`
+ For browser side version of this library
- In version `3.0.0` onwards `Buffer` related code has been excluded.
- Filesize of the `min.js` version is now `6.5KB`. Earlier it was `40KB`.

## Version 2.1.2 - 2.1.6

Expand Down
8 changes: 3 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "dynamodb-data-types",
"version": "3.0.0",
"description": "A convenience utility for Amazon DynamoDB Data Types.",
"description": "A utility to help represent Amazon DynamoDB Data Types.",
"main": "./lib/dynamodb-data-types.js",
"devDependencies": {
"async": "0.2.9",
Expand Down Expand Up @@ -32,11 +32,9 @@
"build-browser-with-buffer": "browserify browser.js > dist-with-buffer/dynamodb-data-types.js && uglifyjs dist-with-buffer/dynamodb-data-types.js --source-map dist-with-buffer/dynamodb-data-types.min.map -o dist-with-buffer/dynamodb-data-types.min.js"
},
"keywords": [
"dynamodb mapper",
"dynamodb marshaller",
"dynamodb json format",
"dynamodb data types",
"dynamodb format attributes",
"marshall dynamodb",
"dynamodb mapper",
"amazon",
"aws"
],
Expand Down

0 comments on commit 5bb4c7a

Please sign in to comment.