### Type parameters

- #### T

### Hierarchy

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

## Index

### Constructors

- constructor

### Properties

- dynamoRx
- logger
- metadata
- modelClazz
- params
- tableName

### Methods

- consistentRead
- exec
- execFullResponse
- execNoMap
- fetch
- mapResponse
- returnConsumedCapacity

## Constructors

### constructor

- new BatchGetSingleTableRequest(dynamoRx: DynamoRx, modelClazz: ModelConstructor<T>, keys: Array<Partial<T>>): BatchGetSingleTableRequest

- Overrides BaseRequest.constructor

  - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:19

  #### Parameters

  - ##### dynamoRx: DynamoRx

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

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

  #### Returns BatchGetSingleTableRequest

## Properties

### dynamoRx

dynamoRx: DynamoRx

Inherited from BaseRequest.dynamoRx

- Defined in dynamo/request/base.request.ts:28

### Private logger

logger: Logger

- Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:19

### metadata

metadata: Metadata<T>

Inherited from BaseRequest.metadata

- Defined in dynamo/request/base.request.ts:30

### modelClazz

modelClazz: ModelConstructor<T>

Inherited from BaseRequest.modelClazz

- Defined in dynamo/request/base.request.ts:29

### params

params: BatchGetItemInput

Inherited from BaseRequest.params

- Defined in dynamo/request/base.request.ts:32

### tableName

tableName: string

Inherited from BaseRequest.tableName

- Defined in dynamo/request/base.request.ts:31

## Methods

### consistentRead

- consistentRead(value?: boolean): BatchGetSingleTableRequest<T>

- - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:36

  #### Parameters

  - ##### Default value value: boolean = true

  #### Returns BatchGetSingleTableRequest<T>

### exec

- exec(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Observable<T[]>

- - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:73

  fetch all entries and return the mapped entries as an array

  #### Parameters

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

    when unprocessed keys are returned the next value of backoffTimer is used to determine how many time slots to wait before doing the next request

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

    the duration of a time slot in ms

  #### Returns Observable<T[]>

### execFullResponse

- execFullResponse(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Observable<BatchGetSingleTableResponse<T>>

- - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:58

  fetch all entries and return an object containing the mapped items and the other response data

  #### Parameters

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

    when unprocessed keys are returned the next value of backoffTimer is used to determine how many time slots to wait before doing the next request

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

    the duration of a time slot in ms

  #### Returns Observable<BatchGetSingleTableResponse<T>>

### execNoMap

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

- - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:46

  fetch all entries and return an the raw response (no mapping of items)

  #### Parameters

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

    when unprocessed keys are returned the next value of backoffTimer is used to determine how many time slots to wait before doing the next request

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

    the duration of a time slot in ms

  #### Returns Observable<BatchGetItemOutput>

### Private fetch

- fetch(backoffTimer?: randomExponentialBackoffTimer, throttleTimeSlot?: number): Observable<BatchGetItemOutput>

- - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:96

  #### Parameters

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

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

  #### Returns Observable<BatchGetItemOutput>

### Private mapResponse

- mapResponse(response: BatchGetItemOutput): object

- - Defined in dynamo/request/batchgetsingletable/batch-get-single-table.request.ts:81

  #### Parameters

  - ##### response: BatchGetItemOutput

  #### Returns object

  - ##### ConsumedCapacity: undefined | ConsumedCapacity[]

  - ##### Items: T[]

  - ##### UnprocessedKeys: undefined | object

### returnConsumedCapacity

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

- Inherited from BaseRequest.returnConsumedCapacity

  - Defined in dynamo/request/base.request.ts:53

  #### Parameters

  - ##### level: DynamoDB.ReturnConsumedCapacity

  #### Returns BatchGetSingleTableRequest<T>

Generated using TypeDoc