ConditionalDelete
Command to remove an item with a condition expression.
Example
Section titled “Example”import { DynamoTable, DynamoEntity, key, ConditionalDelete } from 'dynamo-document-builder';
const table = new DynamoTable({ tableName: 'ExampleTable', documentClient,});
const userEntity = new DynamoEntity({ table, schema: z.object({ userId: z.string(), status: z.string(), }), partitionKey: user => key('USER', user.userId), sortKey: () => 'METADATA',});
const conditionalDeleteCommand = new ConditionalDelete({ key: { userId: 'user123' }, condition: { status: 'inactive' }, returnValues: 'ALL_OLD',});
const { deletedItem } = await userEntity.send(conditionalDeleteCommand);Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
The Zod schema defining the structure of the entity.
Implements
Section titled “Implements”BaseCommand<ConditionalDeleteResult<Schema>,Schema>WriteTransactable<Schema>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ConditionalDelete<Schema>(config): ConditionalDelete<Schema>;Parameters
Section titled “Parameters”config
Section titled “config”ConditionalDeleteConfig<Schema>
Returns
Section titled “Returns”ConditionalDelete<Schema>
Methods
Section titled “Methods”execute()
Section titled “execute()”execute(entity): Promise<ConditionalDeleteResult<Schema>>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”Promise<ConditionalDeleteResult<Schema>>
Implementation of
Section titled “Implementation of”prepareWriteTransaction()
Section titled “prepareWriteTransaction()”prepareWriteTransaction(entity): Promise<TransactWriteOperation>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”Promise<TransactWriteOperation>