Merge pull request #236 from shiftcode/#230-consistent-read-option-read-many

feat(read-many.request): consistentRead support for query/scan

Author: michaelwittwer

src/dynamo/request/read-many.request.spec.ts

@@ -108,6 +108,22 @@ describe('ReadManyRequest', () => {
     })
   })
 
+  describe('consistentRead', () => {
+    beforeEach(() => {
+      request = new TestRequest(SimpleWithCompositePartitionKeyModel)
+    })
+
+    it('should set param for consistent read', () => {
+      request.consistentRead(true)
+      expect(request.params.ConsistentRead).toBe(true)
+    })
+
+    it('should return instance', () => {
+      const r = request.consistentRead(true)
+      expect(r).toBe(request)
+    })
+  })
+
   describe('conditions functions', () => {
     beforeEach(() => {
       request = new TestRequest(SimpleWithPartitionKeyModel)

src/dynamo/request/read-many.request.ts

@@ -98,6 +98,14 @@ export abstract class ReadManyRequest<
     return <any>this
   }
 
+  /**
+   * Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
+   */
+  consistentRead(consistentRead: boolean = true): R {
+    this.params.ConsistentRead = consistentRead
+    return <any>this
+  }
+
   /**
    * add a condition for propertyPath
    * @example req.whereAttribute('path.to.prop').eq('value')