Class TransactionBuilder

Build and executes a TransactWriteItems request

Constructors

constructor

Properties

#errorMessages #transactionItems

Methods

addConditionCheck addDelete addPut addUpdate buildTransactionCanceledException executeTransaction trackErrorMessage

Constructors

constructor

Properties

Private Readonly #errorMessages

#errorMessages: Record<number, string> = {}

Private Readonly #transactionItems

#transactionItems: (Omit<TransactWriteItem, "ConditionCheck" | "Put" | "Delete" | "Update"> & {})[] = []

Methods

addConditionCheck

  • addConditionCheck(item, conditionFailedMsg): void

  • Add a conditional check to the transaction

    Parameters

    • item: Omit<ConditionCheck, "Key" | "ExpressionAttributeValues"> & {}
    • conditionFailedMsg: string

    Returns void

addDelete

  • addDelete(item, conditionFailedMsg?): void

  • Add a delete operation to the transaction

    Parameters

    • item: Omit<Delete, "Key" | "ExpressionAttributeValues"> & {}
    • Optional conditionFailedMsg: string

    Returns void

addPut

  • addPut(item, conditionFailedMsg?): void

  • Add a put operation to the transaction

    Parameters

    • item: Omit<Put, "Item" | "ExpressionAttributeValues"> & {}
    • Optional conditionFailedMsg: string

    Returns void

addUpdate

  • addUpdate(item, conditionFailedMsg?): void

  • Add an update operation to the transaction

    Parameters

    • item: Omit<Update, "Key" | "ExpressionAttributeValues"> & {}
    • Optional conditionFailedMsg: string

    Returns void

Private buildTransactionCanceledException

  • buildTransactionCanceledException(error): AggregateError | TransactionCanceledException

  • Handle TransactionCanceledException, aggregating errors and applying friendly errors if provided.

    Parameters

    • error: TransactionCanceledException

    Returns AggregateError | TransactionCanceledException

executeTransaction

Private trackErrorMessage

  • trackErrorMessage(errMsg?): void

  • Track error messages to return if there is a ConditionalCheckFailed exception

    IMPORTANT - Call this before adding the transaction to this.#transactionItems

    Parameters

    • Optional errMsg: string

      The custom error message to return if there is a ConditionalCheckFailed exception

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor#errorMessages#transactionItemsaddConditionCheckaddDeleteaddPutaddUpdatebuildTransactionCanceledExceptionexecuteTransactiontrackErrorMessage

Generated using TypeDoc