GetRequest | @shiftcoders/dynamo-easy

Type parameters

T
T2

Hierarchy

StandardRequest<T, T2, GetItemInput, GetRequest<T, T2>>
- GetRequest

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GetRequest(dynamoDBWrapper: DynamoDbWrapper, modelClazz: ModelConstructor<T>, partitionKey: any, sortKey: any): GetRequest

Overrides StandardRequest.constructor
- Defined in dynamo/request/get/get.request.ts:19
Parameters
- dynamoDBWrapper: DynamoDbWrapper
- modelClazz: ModelConstructor<T>
- partitionKey: any
- Optional sortKey: any
Returns GetRequest

Properties

dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: GetItemInput

tableName

tableName: string

Methods

consistentRead

consistentRead(consistentRead?: boolean): this

- Defined in dynamo/request/get/get.request.ts:30
Parameters
- Default value consistentRead: boolean = true
Returns this

exec

exec(): Promise<T2 | null>

Overrides BaseRequest.exec
- Defined in dynamo/request/get/get.request.ts:66
Returns Promise<T2 | null>

execFullResponse

execFullResponse(): Promise<GetResponse<T2>>

Overrides BaseRequest.execFullResponse
- Defined in dynamo/request/get/get.request.ts:44
Returns Promise<GetResponse<T2>>

projectionExpression

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

- Defined in dynamo/request/get/get.request.ts:39
Parameters
- Rest attributesToGet: Array<keyof T | string>
Returns GetRequest<T, Partial<T>>

returnConsumedCapacity

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

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