BatchGetRequest | @shiftcoders/dynamo-easy

Hierarchy

BatchGetRequest

Index

Constructors

constructor

Properties

params

Accessors

dynamoDB

Methods

Constructors

constructor

new BatchGetRequest(dynamoDB: DynamoDB): BatchGetRequest

- Defined in dynamo/batchget/batch-get.request.ts:28
Parameters
- Optional dynamoDB: DynamoDB
Returns BatchGetRequest

Properties

params

params: BatchGetItemInput

Accessors

dynamoDB

dynamoDB:

Methods

exec

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

- Defined in dynamo/batchget/batch-get.request.ts:109
Parameters
- Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer
- Default value throttleTimeSlot: number = BATCH_GET_DEFAULT_TIME_SLOT
Returns Promise<BatchGetResponse>

execFullResponse

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

- Defined in dynamo/batchget/batch-get.request.ts:97
Parameters
- Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer
- Default value throttleTimeSlot: number = BATCH_GET_DEFAULT_TIME_SLOT
Returns Promise<BatchGetFullResponse>

execNoMap

execNoMap(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Promise<BatchGetItemOutput>

- Defined in dynamo/batchget/batch-get.request.ts:85
Parameters
- Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer
- Default value throttleTimeSlot: number = BATCH_GET_DEFAULT_TIME_SLOT
Returns Promise<BatchGetItemOutput>

forModel

forModel<T>(modelClazz: ModelConstructor<T>, keys: Array<Partial<T>>, consistentRead?: boolean): BatchGetRequest

- Defined in dynamo/batchget/batch-get.request.ts:51
Type parameters
- T
Parameters
- modelClazz: ModelConstructor<T>
- keys: Array<Partial<T>>
- Default value consistentRead: boolean = false
Returns BatchGetRequest

returnConsumedCapacity

returnConsumedCapacity(level: DynamoDB.ReturnConsumedCapacity): BatchGetRequest

- Defined in dynamo/batchget/batch-get.request.ts:40
Parameters
- level: DynamoDB.ReturnConsumedCapacity
Returns BatchGetRequest