|
1 | | -# DynamoDB Toolbox - v0.3 (WIP: TypeScript Conversion) |
| 1 | +# DynamoDB Toolbox |
2 | 2 |
|
3 | | -[](https://travis-ci.org/jeremydaly/dynamodb-toolbox) |
| 3 | +[](https://travis-ci.org/jeremydaly/dynamodb-toolbox) |
4 | 4 | [](https://www.npmjs.com/package/dynamodb-toolbox) |
5 | 5 | [](https://www.npmjs.com/package/dynamodb-toolbox) |
6 | | -[](https://coveralls.io/github/jeremydaly/dynamodb-toolbox?branch=v0.3) |
| 6 | +[](https://coveralls.io/github/jeremydaly/dynamodb-toolbox?branch=master) |
7 | 7 |
|
8 | 8 |  |
9 | 9 |
|
10 | | - |
11 | | -**NOTE:** This version is a work in progress. Please submit [issues/feedback](https://github.com/jeremydaly/dynamodb-toolbox/issues) or feel free to contact me on Twitter [@jeremy_daly](https://twitter.com/jeremy_daly). |
12 | | - |
13 | 10 | ## Single Table Designs have never been this easy! |
14 | 11 |
|
15 | 12 | The **DynamoDB Toolbox** is a set of tools that makes it easy to work with [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and the [DocumentClient](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-document-client.html). It's designed with **Single Tables** in mind, but works just as well with multiple tables. It lets you define your Entities (with typings and aliases) and map them to your DynamoDB tables. You can then **generate the API parameters** to `put`, `get`, `delete`, `update`, `query`, `scan`, `batchGet`, and `batchWrite` data by passing in JavaScript objects. The DynamoDB Toolbox will map aliases, validate and coerce types, and even write complex `UpdateExpression`s for you. 😉 |
@@ -148,10 +145,11 @@ If you like working with ORMs, that's great, and you should definitely give thes |
148 | 145 | - **Batch Operations:** Full support for batch operations with a simpler interface to work with multiple entities and tables. |
149 | 146 | - **Transactions:** Full support for transaction with a simpler interface to work with multiple entities and tables. |
150 | 147 | - **Default Value Dependency Graphs:** Create dynamic attribute defaults by chaining other dynamic attribute defaults together. |
| 148 | +- **TypeScript Support:** v0.3 of this library was rewritten in TypeScript to provide strong typing support. Additional work is still required to support schema typing. |
151 | 149 |
|
152 | 150 | ## Table of Contents |
153 | 151 |
|
154 | | -- [DynamoDB Toolbox - v0.3 (WIP: TypeScript Conversion)](#dynamodb-toolbox---v03-wip-typescript-conversion) |
| 152 | +- [DynamoDB Toolbox](#dynamodb-toolbox) |
155 | 153 | - [Single Table Designs have never been this easy!](#single-table-designs-have-never-been-this-easy) |
156 | 154 | - [Installation and Basic Usage](#installation-and-basic-usage) |
157 | 155 | - [This is *NOT* an ORM (at least it's not trying to be)](#this-is-not-an-orm-at-least-its-not-trying-to-be) |
@@ -1263,4 +1261,4 @@ let results = await MyEntity.update(item, {}, { |
1263 | 1261 | <IMG SRC="https://ad.doubleclick.net/ddm/trackimp/N1116303.3950900PODSEARCH.COM/B24770737.285235234;dc_trk_aid=479074825;dc_trk_cid=139488579;ord=[timestamp];dc_lat=;dc_rdid=;tag_for_child_directed_treatment=;tfua=;gdpr=${GDPR};gdpr_consent=${GDPR_CONSENT_755}?" BORDER="0" HEIGHT="1" WIDTH="1" ALT="Advertisement"> |
1264 | 1262 |
|
1265 | 1263 | ## Contributions and Feedback |
1266 | | -Contributions, ideas and bug reports are welcome and greatly appreciated. Please add [issues](https://github.com/jeremydaly/dynamodb-toolbox/issues) for suggestions and bug reports or create a pull request. You can also contact me on Twitter: [@jeremy_daly](https://twitter.com/jeremy_daly). |
| 1264 | +Contributions, ideas and bug reports are welcome and greatly appreciated. Please add [issues](https://github.com/jeremydaly/dynamodb-toolbox/issues) for suggestions and bug reports or create a pull request. You can also contact me on Twitter: [@jeremy_daly](https://twitter.com/jeremy_daly). |
0 commit comments