Merge pull request #4 from mindler-sasu/main

prevent await on instance

src/queryBuilders/getItemQueryBuilder.ts

@@ -7,6 +7,7 @@ import {
   SelectAttributes,
   StripKeys,
 } from "../typeHelpers";
+import { preventAwait } from "../util/preventAwait";
 
 export interface GetQueryBuilderInterface<DDB, Table extends keyof DDB, O> {
   keys<Keys extends PickPk<DDB[Table]> & PickSkRequired<DDB[Table]>>(
@@ -89,6 +90,11 @@ export class GetQueryBuilder<DDB, Table extends keyof DDB, O extends DDB[Table]>
   };
 }
 
+preventAwait(
+  GetQueryBuilder,
+  "Don't await GetQueryBuilder instances directly. To execute the query you need to call the `execute` method"
+);
+
 interface GetQueryBuilderProps {
   readonly node: GetNode;
   readonly ddbClient: DynamoDBDocumentClient;

src/tsynamo.integration.test.ts

@@ -94,6 +94,21 @@ describe("tsynamo", () => {
       expect(data?.someBoolean).toBe(TEST_ITEM_1.someBoolean);
       expect(Object.keys(data!).length).toBe(2);
     });
+    it("can't await instance directly", async () => {
+      expect(
+        async () =>
+          await tsynamoClient
+            .getItemFrom("myTable")
+            .keys({
+              userId: TEST_ITEM_1.userId,
+              timestamp: TEST_ITEM_1.timestamp,
+            })
+            .consistentRead(true)
+            .attributes(["somethingElse", "someBoolean"])
+      ).rejects.toThrowError(
+        "Don't await GetQueryBuilder instances directly. To execute the query you need to call the `execute` method"
+      );
+    });
   });
 
   describe("query", () => {

src/util/preventAwait.ts

@@ -0,0 +1,10 @@
+export const preventAwait = (c: Function, message: string): void => {
+  Object.defineProperties(c.prototype, {
+    then: {
+      enumerable: false,
+      value: () => {
+        throw new Error(message);
+      },
+    },
+  });
+};