ConditionCheck

Command to verify a condition without modifying data in a transaction.

Example

import { DynamoTable, DynamoEntity, key, TransactWrite, ConditionCheck, Update } from 'dynamo-document-builder';

const table = new DynamoTable({
  tableName: 'ExampleTable',
  documentClient,
});

const userEntity = new DynamoEntity({
  table,
  schema: z.object({
    userId: z.string(),
    balance: z.number(),
  }),
  partitionKey: user => key('USER', user.userId),
  sortKey: () => 'METADATA',
});

const transactWriteCommand = new TransactWrite({
  writes: [
    new ConditionCheck({
      key: { userId: 'user1' },
      condition: { balance: greaterThan(100) },
    }),
    new Update({ key: { userId: 'user2' }, update: { balance: add(50) } }),
  ],
});

await userEntity.send(transactWriteCommand);

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

• WriteTransactable<Schema>

Constructors

Constructor

new ConditionCheck<Schema>(config): ConditionCheck<Schema>;

Parameters

config

ConditionCheckConfig<Schema>

Returns

ConditionCheck<Schema>

Methods

prepareWriteTransaction()

prepareWriteTransaction(entity): Promise<TransactWriteOperation>;

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<TransactWriteOperation>

Implementation of

WriteTransactable.prepareWriteTransaction