BatchWriteRequest | @shiftcoders/dynamo-easy

Hierarchy

BatchWriteRequest

Index

Constructors

constructor

Properties

params

Accessors

dynamoDB

Methods

Constructors

constructor

new BatchWriteRequest(dynamoDB: DynamoDB): BatchWriteRequest

- Defined in dynamo/batchwrite/batch-write.request.ts:23
Parameters
- Optional dynamoDB: DynamoDB
Returns BatchWriteRequest

Properties

params

params: BatchWriteItemInput

Accessors

dynamoDB

dynamoDB:

Methods

delete

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

- Defined in dynamo/batchwrite/batch-write.request.ts:53
Type parameters
- T
Parameters
- modelClazz: ModelConstructor<T>
- keys: Array<Partial<T>>
Returns BatchWriteRequest

exec

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

- Defined in dynamo/batchwrite/batch-write.request.ts:73
Parameters
- Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer
- Default value throttleTimeSlot: number = BATCH_WRITE_DEFAULT_TIME_SLOT
Returns Promise<void>

execFullResponse

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

- Defined in dynamo/batchwrite/batch-write.request.ts:84
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:63
Type parameters
- T
Parameters
- modelClazz: ModelConstructor<T>
- items: T[]
Returns BatchWriteRequest

returnConsumedCapacity

returnConsumedCapacity(value: DynamoDB.ReturnConsumedCapacity): BatchWriteRequest

- Defined in dynamo/batchwrite/batch-write.request.ts:35
Parameters
- value: DynamoDB.ReturnConsumedCapacity
Returns BatchWriteRequest

returnItemCollectionMetrics

returnItemCollectionMetrics(value: DynamoDB.ReturnItemCollectionMetrics): BatchWriteRequest

- Defined in dynamo/batchwrite/batch-write.request.ts:43
Parameters
- value: DynamoDB.ReturnItemCollectionMetrics
Returns BatchWriteRequest