dyna-record 0.0.10 → 0.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +7 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -22,6 +22,7 @@ Note: ACID compliant according to DynamoDB [limitations](https://docs.aws.amazon
22
22
  - [Delete](#delete)
23
23
  - [Type Safety Features](#type-safety-features)
24
24
  - [Best Practices](#best-practices)
25
+ - [Debug Logging](#debug-logging)
25
26
 
26
27
  ## Getting Started
27
28
 
@@ -276,10 +277,10 @@ To use the create method, call it on the model class you wish to create a new re
276
277
  #### Basic Usage
277
278
 
278
279
  ```typescript
279
- const order: Order = await Order.create({
280
- customerId: "123",
281
- paymentMethodId: "456",
282
- orderDate: new Date("2024-01-01")
280
+ const myModel: MyModel = await MyModel.create({
281
+ someAttr: "123",
282
+ otherAttr: 456,
283
+ someDate: new Date("2024-01-01")
283
284
  });
284
285
  ```
285
286
 
@@ -369,7 +370,7 @@ const result = await Customer.query("123", {
369
370
  });
370
371
  ```
371
372
 
372
- ##### Query by id
373
+ ##### Query by primary key
373
374
 
374
375
  To be more precise to the underlying data, you can specify the partition key and sort key directly. The keys here will be the partition and sort keys defined on the [table](#table) class.
375
376
 
@@ -409,7 +410,7 @@ const result = await Course.query(
409
410
  );
410
411
  ```
411
412
 
412
- ### Querying on an indexes
413
+ ### Querying on an index
413
414
 
414
415
  For querying based on secondary indexes, you can specify the index name in the options.
415
416
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dyna-record",
3
- "version": "0.0.10",
3
+ "version": "0.0.12",
4
4
  "description": "Typescript Object Relational Mapper (ORM) for Dynamo",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",