UpdateRequest | @shiftcoders/dynamo-easy

Type parameters

T
T2

Hierarchy

WriteRequest<T, T2, UpdateItemInput, UpdateItemOutput, UpdateRequest<T, T2>>
- UpdateRequest

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overrides WriteRequest.constructor
- Defined in dynamo/request/update/update.request.ts:25
Parameters
- dynamoDBWrapper: DynamoDbWrapper
- modelClazz: ModelConstructor<T>
- partitionKey: any
- Optional sortKey: any
Returns UpdateRequest

Properties

dynamoDBWrapper

dynamoDBWrapper: DynamoDbWrapper

Protected logger

logger: Logger

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: UpdateItemInput

tableName

tableName: string

Methods

Protected doRequest

doRequest(params: UpdateItemInput): Promise<UpdateItemOutput>

Overrides WriteRequest.doRequest
- Defined in dynamo/request/update/update.request.ts:60
Parameters
- params: UpdateItemInput
Returns Promise<UpdateItemOutput>

exec

exec(): Promise<T2>

Inherited from WriteRequest.exec

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<UpdateItemOutput, T2>>

Inherited from WriteRequest.execFullResponse

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

execNoMap

execNoMap(): Promise<UpdateItemOutput>

Inherited from WriteRequest.execNoMap
- Defined in dynamo/request/write.request.ts:110
Returns Promise<UpdateItemOutput>

onlyIf

onlyIf(conditionDefFns: ConditionExpressionDefinitionFunction[]): this

Inherited from WriteRequest.onlyIf
- 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>

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

operations

operations(updateDefFns: UpdateExpressionDefinitionFunction[]): this

- Defined in dynamo/request/update/update.request.ts:45
Parameters
- Rest updateDefFns: UpdateExpressionDefinitionFunction[]
Returns this

returnConsumedCapacity

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

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

returnItemCollectionMetrics

returnItemCollectionMetrics(returnItemCollectionMetrics: DynamoDB.ReturnItemCollectionMetrics): this

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

returnValues

returnValues(returnValues: "ALL_OLD" | "ALL_NEW"): UpdateRequest<T, T>
returnValues(returnValues: "UPDATED_OLD" | "UPDATED_NEW"): UpdateRequest<T, Partial<T>>
returnValues(returnValues: "NONE"): UpdateRequest<T, void>

- Defined in dynamo/request/update/update.request.ts:50
Parameters
- returnValues: "ALL_OLD" | "ALL_NEW"
Returns UpdateRequest<T, T>
- Defined in dynamo/request/update/update.request.ts:51
Parameters
- returnValues: "UPDATED_OLD" | "UPDATED_NEW"
Returns UpdateRequest<T, Partial<T>>
- Defined in dynamo/request/update/update.request.ts:52
Parameters
- returnValues: "NONE"
Returns UpdateRequest<T, void>

updateAttribute

updateAttribute<K>(attributePath: K): RequestUpdateFunction<this, T, K>

- Defined in dynamo/request/update/update.request.ts:37
Type parameters
- K: keyof T
Parameters
- attributePath: K
Returns RequestUpdateFunction<this, T, K>