BatchGetSingleTableRequest | @shiftcoders/dynamo-easy

Type parameters

T
T2

Hierarchy

BaseRequest<T, T2, BatchGetItemInput, BatchGetSingleTableRequest<T, T2>>
- BatchGetSingleTableRequest

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BatchGetSingleTableRequest(dynamoDBWrapper: DynamoDbWrapper, modelClazz: ModelConstructor<T>, keys: Array<Partial<T>>): BatchGetSingleTableRequest

Overrides BaseRequest.constructor
- Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:27
Parameters
- dynamoDBWrapper: DynamoDbWrapper
- modelClazz: ModelConstructor<T>
- keys: Array<Partial<T>>
Returns BatchGetSingleTableRequest

Properties

dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: BatchGetItemInput

tableName

tableName: string

Methods

consistentRead

consistentRead(value?: boolean): this

- Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:47
Parameters
- Default value value: boolean = true
Returns this

exec

exec(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Promise<T2[]>

Overrides BaseRequest.exec
- Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:92
Parameters
- Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer
- Default value throttleTimeSlot: number = BATCH_GET_DEFAULT_TIME_SLOT
Returns Promise<T2[]>

execFullResponse

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

Overrides BaseRequest.execFullResponse
- Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:78
Parameters
- Default value backoffTimer: randomExponentialBackoffTimer = randomExponentialBackoffTimer
- Default value throttleTimeSlot: number = BATCH_GET_DEFAULT_TIME_SLOT
Returns Promise<BatchGetSingleTableResponse<T2>>

execNoMap

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

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

projectionExpression

projectionExpression(attributesToGet: Array<keyof T | string>): BatchGetSingleTableRequest<T, Partial<T>>

- Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:56
Parameters
- Rest attributesToGet: Array<keyof T | string>
Returns BatchGetSingleTableRequest<T, Partial<T>>

returnConsumedCapacity

returnConsumedCapacity(level: DynamoDB.ReturnConsumedCapacity): BatchGetSingleTableRequest<T, T2>

Inherited from BaseRequest.returnConsumedCapacity
- Defined in dynamo/request/base.request.ts:77
Parameters
- level: DynamoDB.ReturnConsumedCapacity
Returns BatchGetSingleTableRequest<T, T2>