TransactUpdate | @shiftcoders/dynamo-easy

Type parameters

T

Hierarchy

TransactBaseOperation<T, Update, TransactUpdate<T>>
- TransactUpdate

Implements

ConditionalParamsHost

Index

Constructors

constructor

Properties

Accessors

transactItem

Methods

Constructors

constructor

new TransactUpdate(modelClazz: ModelConstructor<T>, partitionKey: any, sortKey: any): TransactUpdate

Overrides TransactBaseOperation.constructor
- Defined in dynamo/transactwrite/transact-update.ts:16
Parameters
- modelClazz: ModelConstructor<T>
- partitionKey: any
- Optional sortKey: any
Returns TransactUpdate

Properties

metadata

metadata: Metadata<T>

modelClazz

modelClazz: ModelConstructor<T>

params

params: Update

Accessors

transactItem

transactItem:

Methods

onlyIf

onlyIf(conditionDefFns: ConditionExpressionDefinitionFunction[]): this

Inherited from TransactBaseOperation.onlyIf
- Defined in dynamo/transactwrite/transact-base-operation.ts:65
Parameters
- Rest conditionDefFns: ConditionExpressionDefinitionFunction[]
Returns this

onlyIfAttribute

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

Inherited from TransactBaseOperation.onlyIfAttribute
- Defined in dynamo/transactwrite/transact-base-operation.ts:53
Type parameters
- K: keyof T
Parameters
- attributePath: K
Returns RequestConditionFunctionTyped<this, T, K>
Inherited from TransactBaseOperation.onlyIfAttribute
- Defined in dynamo/transactwrite/transact-base-operation.ts:54
Parameters
- attributePath: string
Returns RequestConditionFunction<this, T>

operations

operations(updateDefFns: UpdateExpressionDefinitionFunction[]): this

- Defined in dynamo/transactwrite/transact-update.ts:34
Parameters
- Rest updateDefFns: UpdateExpressionDefinitionFunction[]
Returns this

returnValuesOnConditionCheckFailure

returnValuesOnConditionCheckFailure(value: DynamoDB.ReturnValuesOnConditionCheckFailure): this

Inherited from TransactBaseOperation.returnValuesOnConditionCheckFailure
- Defined in dynamo/transactwrite/transact-base-operation.ts:74
Parameters
- value: DynamoDB.ReturnValuesOnConditionCheckFailure
Returns this

updateAttribute

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

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