Skip to content

Commit bd9c43c

Browse files
committed
misc todo cleanup
1 parent bc0eb14 commit bd9c43c

File tree

5 files changed

+2
-11
lines changed

5 files changed

+2
-11
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,8 @@ attributes: {
385385
```
386386

387387
#### Using an `array` for composite keys
388-
- [ ] This needs some work
388+
389+
**NOTE:** The interface for composite keys may be changing in v0.2 to make it easier to customize.
389390

390391
Composite keys in DynamoDB are incredibly useful for creating hierarchies, one-to-many relationships, and other powerful querying capabilities (see [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-sort-keys.html)). The DynamoDB Toolbox lets you easily work with composite keys in a number of ways. In many cases, there is no need to store the data in the same record twice if you are already combining it into a single attribute. By using composite key mappings, you can store data together in a single field, but still be able to structure input data *and* parse the output into separate attributes.
391392

__tests__/expressionBuilder.unit.test.js

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
// TODO: Additional expression builder tests
2-
31
const expressionBuilder = require('../lib/expressionBuilder')
42

53
// Require Table and Entity classes

classes/Entity.js

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
'use strict'
22

3-
// TODO: make sure pks and sks are of correct types
4-
53
/**
64
* DynamoDB Toolbox: A simple set of tools for working with Amazon DynamoDB
75
* @author Jeremy Daly <[email protected]>
@@ -659,8 +657,6 @@ class Entity {
659657
returnValues ? { ReturnValues: returnValues.toUpperCase() } : null,
660658
) // end assign
661659

662-
// console.log(payload)
663-
664660
return payload
665661

666662
// TODO: Check why primary/secondary GSIs are using if_not_exists

index.js

-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,8 @@
77
* @license MIT
88
*/
99

10-
1110
// TODO: Check param merging
1211
// TODO: 'Remove null fields' option
13-
// TODO: Tests, tests, and more tests
14-
// TODO: Documentation updates 😳
1512
// TODO: prevent reserved field names?
1613

1714
const Table = require('./classes/Table')

lib/expressionBuilder.js

-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ const parseClause = (_clause,grp,table) => {
9595
attr, // attribute
9696
size, // wraps attr in size()
9797
negate, // negates expression
98-
// TODO: thing about the name of this
9998
or, // change logical evaluator to OR
10099
eq, // =
101100
ne, // <>

0 commit comments

Comments
 (0)