Delete

Command to remove an item from a DynamoDB table.

Example

import { DynamoTable, DynamoEntity, key, Delete } from 'dynamo-document-builder';

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

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

const deleteCommand = new Delete({
  key: { userId: 'user123' },
  returnValues: 'ALL_OLD',
});

const { deletedItem } = await userEntity.send(deleteCommand);

Type Parameters

Schema

Schema extends ZodObject

The Zod schema defining the structure of the entity.

Implements

BaseCommand<DeleteResult<Schema>, Schema>
WriteTransactable<Schema>

Constructors

Constructor

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

Parameters

config

DeleteConfig<Schema>

Returns

Delete<Schema>

Methods

execute()

execute(entity): Promise<DeleteResult<Schema>>;

Parameters

entity

DynamoEntity<Schema>

Returns

Promise<DeleteResult<Schema>>

Implementation of

BaseCommand.execute

prepareWriteTransaction()

prepareWriteTransaction(entity): Promise<TransactWriteOperation>;

Parameters