### Hierarchy

- BatchWriteRequest

## Index

### Constructors

- constructor

### Properties

- dynamoDBWrapper
- itemCount
- params

### Methods

- createDeleteRequest
- createPutRequest
- delete
- exec
- execFullResponse
- put
- requestItems
- returnConsumedCapacity
- returnItemCollectionMetrics
- write

## Constructors

### constructor

- new BatchWriteRequest(): BatchWriteRequest

- - Defined in dynamo/batchwrite/batch-write.request.ts:13

  #### Returns BatchWriteRequest

## Properties

### Private dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

- Defined in dynamo/batchwrite/batch-write.request.ts:12

### Private itemCount

itemCount: number = 0

- Defined in dynamo/batchwrite/batch-write.request.ts:13

### params

params: BatchWriteItemInput

- Defined in dynamo/batchwrite/batch-write.request.ts:11

## Methods

### Private createDeleteRequest

- createDeleteRequest<T>(modelClazz: ModelConstructor<T>): (Anonymous function)

- - Defined in dynamo/batchwrite/batch-write.request.ts:76

  #### Type parameters

  - #### T

  #### Parameters

  - ##### modelClazz: ModelConstructor<T>

  #### Returns (Anonymous function)

### Private createPutRequest

- createPutRequest<T>(modelClazz: ModelConstructor<T>): (Anonymous function)

- - Defined in dynamo/batchwrite/batch-write.request.ts:81

  #### Type parameters

  - #### T

  #### Parameters

  - ##### modelClazz: ModelConstructor<T>

  #### Returns (Anonymous function)

### delete

- delete<T>(modelClazz: ModelConstructor<T>, items: Array<Partial<T>>): BatchWriteRequest

- - Defined in dynamo/batchwrite/batch-write.request.ts:32

  #### Type parameters

  - #### T

  #### Parameters

  - ##### modelClazz: ModelConstructor<T>

  - ##### items: Array<Partial<T>>

  #### Returns BatchWriteRequest

### exec

- exec(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Promise<void>

- - Defined in dynamo/batchwrite/batch-write.request.ts:47

  #### Parameters

  - ##### Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer

    generator for how much timeSlots should be waited before requesting next batch. only used when capacity was exceeded. default randomExponentialBackoffTimer

  - ##### Default value throttleTimeSlot: number = BATCH_WRITE_DEFAULT_TIME_SLOT

    defines how long one timeSlot is for throttling, default 1 second

  #### Returns Promise<void>

### execFullResponse

- execFullResponse(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Promise<BatchWriteItemOutput>

- - Defined in dynamo/batchwrite/batch-write.request.ts:55

  #### Parameters

  - ##### Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer

  - ##### Default value throttleTimeSlot: number = BATCH_WRITE_DEFAULT_TIME_SLOT

  #### Returns Promise<BatchWriteItemOutput>

### put

- put<T>(modelClazz: ModelConstructor<T>, items: T[]): BatchWriteRequest

- - Defined in dynamo/batchwrite/batch-write.request.ts:37

  #### Type parameters

  - #### T

  #### Parameters

  - ##### modelClazz: ModelConstructor<T>

  - ##### items: T[]

  #### Returns BatchWriteRequest

### Private requestItems

- requestItems(modelClazz: ModelConstructor<any>, items: DynamoDB.WriteRequests): void

- - Defined in dynamo/batchwrite/batch-write.request.ts:62

  #### Parameters

  - ##### modelClazz: ModelConstructor<any>

  - ##### items: DynamoDB.WriteRequests

  #### Returns void

### returnConsumedCapacity

- returnConsumedCapacity(value: DynamoDB.ReturnConsumedCapacity): BatchWriteRequest

- - Defined in dynamo/batchwrite/batch-write.request.ts:22

  #### Parameters

  - ##### value: DynamoDB.ReturnConsumedCapacity

  #### Returns BatchWriteRequest

### returnItemCollectionMetrics

- returnItemCollectionMetrics(value: DynamoDB.ReturnItemCollectionMetrics): BatchWriteRequest

- - Defined in dynamo/batchwrite/batch-write.request.ts:27

  #### Parameters

  - ##### value: DynamoDB.ReturnItemCollectionMetrics

  #### Returns BatchWriteRequest

### Private write

- write(backoffTimer: function, throttleTimeSlot: number): Promise<BatchGetItemOutput>

- - Defined in dynamo/batchwrite/batch-write.request.ts:72

  #### Parameters

  - ##### backoffTimer: function

    - - (): IterableIterator<number>

      - #### Returns IterableIterator<number>

  - ##### throttleTimeSlot: number

  #### Returns Promise<BatchGetItemOutput>

Generated using TypeDoc