Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix minor typos #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ This is a simple utility to calculate the size of an item as [DynamoDB](https://
## Usage

```
var dynoItemSize = require('dyno-item-size');
var item = {
const dynoItemSize = require('dyno-item-size');
const item = {
'string': 'string',
'number': 27,
'buffer': new Buffer('buffer', 'utf8')
};
var size = dynoItemSize(item);
const size = dynoItemSize(item);
console.log(size);
// => 32
```

## API

`dynoItemSize` comes with a two helper functions to translate the size of an object into it's read or write capacity cost.
`dynoItemSize` comes with two helper functions to translate the size of an object into its read or write capacity cost.

### `dynoItemSize(object)`

Expand All @@ -38,7 +38,7 @@ Takes an object like the one shown in usage and returns the write capacity cost.

This module has been implemented by reading a few resources.

- [Item Size in DdynamoDB from stack overflow](http://stackoverflow.com/questions/8988389/itemsize-in-dynamodb)
- [Provision Throughput from the AWS DynamoDB docs](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ProvisionedThroughput.html)
- [Item Size in DynamoDB from Stack Overflow](http://stackoverflow.com/questions/8988389/itemsize-in-dynamodb)
- [Provisioned Throughput from the AWS DynamoDB docs](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ProvisionedThroughput.html)
- [Naming Rules and Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
- [Item Sizes and Capacity Unit Consumption](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/CapacityUnitCalculations.html#ItemSizeCalculations.Reads)