Interface WriteTransactionBuilder<TItem, TPKSource, TSKSource>

interface WriteTransactionBuilder<TItem, TPKSource, TSKSource> {
    conditionCheck<TKeySource>(keySource: TKeySource, options: TransactionConditionCheckOptions): WriteTransactionBuilder<TItem, TPKSource, TSKSource>;
    delete<TKeySource>(keySource: TKeySource, options?: TransactionDeleteOptions): WriteTransactionBuilder<TItem, TPKSource, TSKSource>;
    execute(options?: WriteTransactionOptions): Promise<WriteTransactionResponse>;
    nextEntity<TNextItem, TNextPKSource, TNextSKSource>(nextEntity: Entity<TNextItem, TNextPKSource, TNextSKSource>): WriteTransactionBuilder<TNextItem, TNextPKSource, TNextSKSource>;
    put(item: TItem, options?: TransactionPutOptions): WriteTransactionBuilder<TItem, TPKSource, TSKSource>;
    update<TKeySource>(keySource: TKeySource, options: TransactionUpdateOptions): WriteTransactionBuilder<TItem, TPKSource, TSKSource>;
}

Type Parameters

TItem extends TPKSource & TSKSource
TPKSource
TSKSource

Index

Methods

conditionCheck delete execute nextEntity put update

Methods

conditionCheck

conditionCheck<TKeySource>(keySource, options): WriteTransactionBuilder<TItem, TPKSource, TSKSource>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- options: TransactionConditionCheckOptions
Returns WriteTransactionBuilder<TItem, TPKSource, TSKSource>
- Defined in packages/dynamodb-entity-store/src/lib/transactionOperations.ts:35

delete

delete<TKeySource>(keySource, options?): WriteTransactionBuilder<TItem, TPKSource, TSKSource>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- Optionaloptions: TransactionDeleteOptions
Returns WriteTransactionBuilder<TItem, TPKSource, TSKSource>
- Defined in packages/dynamodb-entity-store/src/lib/transactionOperations.ts:30

execute

execute(options?): Promise<WriteTransactionResponse>
Parameters
- Optionaloptions: WriteTransactionOptions
Returns Promise<WriteTransactionResponse>
- Defined in packages/dynamodb-entity-store/src/lib/transactionOperations.ts:44

nextEntity

nextEntity<TNextItem, TNextPKSource, TNextSKSource>(nextEntity): WriteTransactionBuilder<TNextItem, TNextPKSource, TNextSKSource>
Type Parameters
- TNextItem
- TNextPKSource
- TNextSKSource
Parameters
- nextEntity: Entity<TNextItem, TNextPKSource, TNextSKSource>
Returns WriteTransactionBuilder<TNextItem, TNextPKSource, TNextSKSource>
- Defined in packages/dynamodb-entity-store/src/lib/transactionOperations.ts:40

put

put(item, options?): WriteTransactionBuilder<TItem, TPKSource, TSKSource>
Parameters
- item: TItem
- Optionaloptions: TransactionPutOptions
Returns WriteTransactionBuilder<TItem, TPKSource, TSKSource>
- Defined in packages/dynamodb-entity-store/src/lib/transactionOperations.ts:23

update

update<TKeySource>(keySource, options): WriteTransactionBuilder<TItem, TPKSource, TSKSource>
Type Parameters
- TKeySource
Parameters
- keySource: TKeySource
- options: TransactionUpdateOptions
Returns WriteTransactionBuilder<TItem, TPKSource, TSKSource>
- Defined in packages/dynamodb-entity-store/src/lib/transactionOperations.ts:25