betterddb 0.1.0 → 0.2.0

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 (3) hide show
  1. package/lib/betterddb.d.ts +4 -0
  2. package/package.json +1 -1
  3. package/src/betterddb.ts +4 -0
package/lib/betterddb.d.ts CHANGED
@@ -33,7 +33,11 @@ export interface SortKeyConfig<T> {
33
33
  * Configuration for a Global Secondary Index (GSI).
34
34
  */
35
35
  export interface GSIConfig<T> {
36
+ /** The name of the GSI in DynamoDB */
37
+ name: string;
38
+ /** The primary key configuration for the GSI */
36
39
  primary: PrimaryKeyConfig<T>;
40
+ /** The sort key configuration for the GSI, if any */
37
41
  sort?: SortKeyConfig<T>;
38
42
  }
39
43
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "betterddb",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "A definition-based DynamoDB wrapper library that provides a schema-driven and fully typesafe DAL.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
package/src/betterddb.ts CHANGED
@@ -41,7 +41,11 @@ export interface SortKeyConfig<T> {
41
41
  * Configuration for a Global Secondary Index (GSI).
42
42
  */
43
43
  export interface GSIConfig<T> {
44
+ /** The name of the GSI in DynamoDB */
45
+ name: string;
46
+ /** The primary key configuration for the GSI */
44
47
  primary: PrimaryKeyConfig<T>;
48
+ /** The sort key configuration for the GSI, if any */
45
49
  sort?: SortKeyConfig<T>;
46
50
  }
47
51