Class TransactionBuilder

Build and executes a TransactWriteItems request

Index

Constructors

Methods

addConditionCheck addDelete addPut addUpdate executeTransaction overrideConditionFailedMsg

Constructors

constructor

new TransactionBuilder(): TransactionBuilder
Returns TransactionBuilder

Methods

addConditionCheck

addConditionCheck(
item: Omit<ConditionCheck, "ExpressionAttributeValues" | "Key"> & {},
conditionFailedMsg: string,
): void
Add a conditional check to the transaction
Parameters
- item: Omit<ConditionCheck, "ExpressionAttributeValues" | "Key"> & {}
- conditionFailedMsg: string
Returns void
- Defined in src/dynamo-utils/TransactWriteBuilder.ts:45

addDelete

addDelete(
item: Omit<Delete, "ExpressionAttributeValues" | "Key"> & {},
conditionFailedMsg?: string,
): void
Add a delete operation to the transaction
Parameters
- item: Omit<Delete, "ExpressionAttributeValues" | "Key"> & {}
- OptionalconditionFailedMsg: string
Returns void
- Defined in src/dynamo-utils/TransactWriteBuilder.ts:90

addPut

addPut(
item: Omit<Put, "ExpressionAttributeValues" | "Item"> & {},
conditionFailedMsg?: string,
): void
Add a put operation to the transaction
Parameters
- item: Omit<Put, "ExpressionAttributeValues" | "Item"> & {}
- OptionalconditionFailedMsg: string
Returns void
- Defined in src/dynamo-utils/TransactWriteBuilder.ts:57

addUpdate

addUpdate(
item: Omit<Update, "ExpressionAttributeValues" | "Key"> & {},
conditionFailedMsg?: string,
): void
Add an update operation to the transaction
Parameters
- item: Omit<Update, "ExpressionAttributeValues" | "Key"> & {}
- OptionalconditionFailedMsg: string
Returns void
- Defined in src/dynamo-utils/TransactWriteBuilder.ts:66

executeTransaction

executeTransaction(): Promise<void>
Execute the transaction

Returns Promise<void>
- Defined in src/dynamo-utils/TransactWriteBuilder.ts:26

overrideConditionFailedMsg

overrideConditionFailedMsg(
item: Omit<Update, "ExpressionAttributeValues" | "Key"> & {},
errMsg: string,
): void
Replaces the tracked condition-failure message for an already-queued update item, for conditions appended to the item after it was queued
Parameters
- item: Omit<Update, "ExpressionAttributeValues" | "Key"> & {}
  The queued update item, matched by reference
- errMsg: string
  The replacement error message
Returns void
- Defined in src/dynamo-utils/TransactWriteBuilder.ts:77