WriteRequest | @shiftcoders/dynamo-easy

Type parameters

T
T2
I: DeleteItemInput | PutItemInput | UpdateItemInput
O: DeleteItemOutput | PutItemOutput | UpdateItemOutput
R: WriteRequest<T, T2, I, O, R>

Hierarchy

StandardRequest<T, T2, I, R>
- WriteRequest

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new WriteRequest(dynamoDBWrapper: DynamoDbWrapper, modelClazz: ModelConstructor<T>): WriteRequest

Overrides StandardRequest.constructor
- Defined in dynamo/request/write.request.ts:37
Parameters
- dynamoDBWrapper: DynamoDbWrapper
- modelClazz: ModelConstructor<T>
Returns WriteRequest

Properties

dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

Protected Abstract logger

logger: Logger

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: I

tableName

tableName: string

Methods

Protected Abstract doRequest

doRequest(params: I): Promise<O>

- Defined in dynamo/request/write.request.ts:43
Parameters
- params: I
Returns Promise<O>

exec

exec(): Promise<T2>

Overrides BaseRequest.exec
- Defined in dynamo/request/write.request.ts:76
Returns Promise<T2>

if no ReturnValues are requested, { T } if the requested ReturnValues are ALL_OLD|ALL_NEW or {Partial} if the requested ReturnValues are UPDATED_OLD|UPDATED_NEW

execFullResponse

execFullResponse(): Promise<WriteResponse<O, T2>>

Overrides BaseRequest.execFullResponse
- Defined in dynamo/request/write.request.ts:87
Returns Promise<WriteResponse<O, T2>>

execNoMap

execNoMap(): Promise<O>

- Defined in dynamo/request/write.request.ts:110
Returns Promise<O>

onlyIf

onlyIf(conditionDefFns: ConditionExpressionDefinitionFunction[]): this

- Defined in dynamo/request/write.request.ts:67
Parameters
- Rest conditionDefFns: ConditionExpressionDefinitionFunction[]
Returns this

onlyIfAttribute

onlyIfAttribute<K>(attributePath: K): RequestConditionFunctionTyped<this, T, K>
onlyIfAttribute(attributePath: string): RequestConditionFunction<this, T>

- Defined in dynamo/request/write.request.ts:57
Type parameters
- K: keyof T
Parameters
- attributePath: K
Returns RequestConditionFunctionTyped<this, T, K>
- Defined in dynamo/request/write.request.ts:58
Parameters
- attributePath: string
Returns RequestConditionFunction<this, T>

returnConsumedCapacity

returnConsumedCapacity(level: DynamoDB.ReturnConsumedCapacity): R

Inherited from BaseRequest.returnConsumedCapacity
- Defined in dynamo/request/base.request.ts:77
Parameters
- level: DynamoDB.ReturnConsumedCapacity
Returns R

returnItemCollectionMetrics

returnItemCollectionMetrics(returnItemCollectionMetrics: DynamoDB.ReturnItemCollectionMetrics): this

- Defined in dynamo/request/write.request.ts:48
Parameters
- returnItemCollectionMetrics: DynamoDB.ReturnItemCollectionMetrics
Returns this