Class EntityClient<C, CF>

Convenience wrapper around the AWS DynamoDB SDK in addition to BaseEntityClient functionality.

This class exposes DynamoDBClient and DynamoDBDocument for direct access, and delegates high-level operations to small helper modules.

For query operations, use the QueryBuilder class.

Type Parameters

C extends BaseConfigMap
CF = unknown

Hierarchy

BaseEntityClient<C, CF>
- EntityClient

Index

Constructors

constructor

new EntityClient<C extends BaseConfigMap, CF = unknown>(
options: EntityClientOptions<C, CF>,
): EntityClient<C, CF>
DynamoDB EntityClient constructor.
Type Parameters
- C extends BaseConfigMap
- CF = unknown
Parameters
- options: EntityClientOptions<C, CF>
  EntityClientOptions object.
Returns EntityClient<C, CF>
Overrides BaseEntityClient<C, CF>.constructor
- Defined in src/EntityClient/EntityClient.ts:75

Properties

`Readonly`batchProcessOptions

batchProcessOptions: NonNullable<
BaseEntityClientOptions<CC, CF>["batchProcessOptions"],
>

Default batch process options.

`Readonly`client

client: DynamoDBClient

AWS SDK DynamoDBClient instance.

`Readonly`doc

doc: DynamoDBDocument

AWS SDK DynamoDBDocument instance.

`Readonly`entityManager

entityManager: EntityManager<C, CF>

EntityManager instance.

`Readonly`logger

logger: NonNullable<BaseEntityClientOptions<CC, CF>["logger"]>

Injected logger object. Must support debug and error methods. Default: console

`Readonly`tableName

tableName: string

Table name.

Methods

createTable

createTable(
    options: MakeOptional<CreateTableCommandInput, "TableName">,
    waiterConfig?: WaiterConfig,
): Promise<
    {
        createTableCommandOutput: CreateTableCommandOutput;
        waiterResult: WaiterResult;
    },
>
Creates a DynamoDB table and waits for it to become active.
Parameters
- options: MakeOptional<CreateTableCommandInput, "TableName">
  CreateTableCommandInput; TableName defaults to this.tableName.
- waiterConfig: WaiterConfig = ...
  Waiter configuration (default maxWaitTime 60s).
Returns Promise<
    {
        createTableCommandOutput: CreateTableCommandOutput;
        waiterResult: WaiterResult;
    },
>
- Defined in src/EntityClient/EntityClient.ts:107

deleteItem

deleteItem(
key: EntityKey<C>,
options?: MakeOptional<Omit<DeleteCommandInput, "Item">, "TableName">,
): Promise<DeleteCommandOutput>
Deletes an item from a DynamoDB table.
Parameters
- key: EntityKey<C>
  EntityKey object.
- Optionaloptions: MakeOptional<Omit<DeleteCommandInput, "Item">, "TableName">
  DeleteCommandInput with Key omitted; TableName optional.
Returns Promise<DeleteCommandOutput>
- Defined in src/EntityClient/EntityClient.ts:176
deleteItem(
    options: MakeOptional<
        ReplaceKey<DeleteCommandInput, "Key", EntityKey<C>>,
        "TableName",
    >,
): Promise<DeleteCommandOutput>
Deletes an item from a DynamoDB table.
Parameters
- options: MakeOptional<ReplaceKey<DeleteCommandInput, "Key", EntityKey<C>>, "TableName">
  DeleteCommandInput; TableName optional.
Returns Promise<DeleteCommandOutput>
- Defined in src/EntityClient/EntityClient.ts:187

deleteItems

deleteItems(
keys: EntityKey<C>[],
options?: BatchWriteOptions,
): Promise<BatchWriteCommandOutput[]>
Deletes multiple items from a DynamoDB table in batches.
Parameters
- keys: EntityKey<C>[]
  Array of EntityKey.
- Optionaloptions: BatchWriteOptions
  BatchWriteOptions.
Returns Promise<BatchWriteCommandOutput[]>
- Defined in src/EntityClient/EntityClient.ts:224

deleteTable

deleteTable(
    options?: MakeOptional<DeleteTableCommandInput, "TableName">,
    waiterConfig?: WaiterConfig,
): Promise<
    {
        deleteTableCommandOutput: DeleteTableCommandOutput;
        waiterResult: WaiterResult;
    },
>
Deletes a DynamoDB table and waits for it to be confirmed deleted.
Parameters
- options: MakeOptional<DeleteTableCommandInput, "TableName"> = {}
  DeleteTableCommandInput; TableName defaults to this.tableName.
- waiterConfig: WaiterConfig = ...
  Waiter configuration (default maxWaitTime 60s).
Returns Promise<
    {
        deleteTableCommandOutput: DeleteTableCommandOutput;
        waiterResult: WaiterResult;
    },
>
- Defined in src/EntityClient/EntityClient.ts:120

getItem

getItem<ET extends string | number | symbol, A extends readonly string[]>(
    entityToken: ET,
    key: EntityKey<C>,
    attributes: A,
    options?: MakeOptional<
        Omit<
            GetCommandInput,
            | "AttributesToGet"
            | "ProjectionExpression"
            | "ExpressionAttributeNames"
            | "Key",
        >,
        "TableName",
    >,
): Promise<
    Omit<GetCommandOutput, "Item"> & {
        Item?: EntityRecordPartial<C, ET, A>;
    },
>
Token-aware getItem overloads (records). Strip keys in handlers when needed via entityManager.removeKeys.

Token-aware with tuple projection (attributes as const) -> projected DB record
Type Parameters
- ET extends string | number | symbol
- A extends readonly string[]
Parameters
- entityToken: ET
- key: EntityKey<C>
- attributes: A
- Optionaloptions: MakeOptional<
      Omit<
          GetCommandInput,
          | "AttributesToGet"
          | "ProjectionExpression"
          | "ExpressionAttributeNames"
          | "Key",
      >,
      "TableName",
  >
Returns Promise<
    Omit<GetCommandOutput, "Item"> & {
        Item?: EntityRecordPartial<C, ET, A>;
    },
>
- Defined in src/EntityClient/EntityClient.ts:269
getItem<ET extends string | number | symbol>(
    entityToken: ET,
    key: EntityKey<C>,
    attributes: string[],
    options?: MakeOptional<
        Omit<
            GetCommandInput,
            | "AttributesToGet"
            | "ProjectionExpression"
            | "ExpressionAttributeNames"
            | "Key",
        >,
        "TableName",
    >,
): Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>
Token-aware getItem overloads (records). Strip keys in handlers when needed via entityManager.removeKeys.

Token-aware with tuple projection (attributes as const) -> projected DB record
Type Parameters
- ET extends string | number | symbol
Parameters
- entityToken: ET
- key: EntityKey<C>
- attributes: string[]
- Optionaloptions: MakeOptional<
      Omit<
          GetCommandInput,
          | "AttributesToGet"
          | "ProjectionExpression"
          | "ExpressionAttributeNames"
          | "Key",
      >,
      "TableName",
  >
Returns Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>
- Defined in src/EntityClient/EntityClient.ts:289
getItem<ET extends string | number | symbol>(
    entityToken: ET,
    key: EntityKey<C>,
    options?: MakeOptional<
        Omit<
            GetCommandInput,
            | "AttributesToGet"
            | "ProjectionExpression"
            | "ExpressionAttributeNames"
            | "Key",
        >,
        "TableName",
    >,
): Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>
Token-aware getItem overloads (records). Strip keys in handlers when needed via entityManager.removeKeys.

Token-aware with tuple projection (attributes as const) -> projected DB record
Type Parameters
- ET extends string | number | symbol
Parameters
- entityToken: ET
- key: EntityKey<C>
- Optionaloptions: MakeOptional<
      Omit<
          GetCommandInput,
          | "AttributesToGet"
          | "ProjectionExpression"
          | "ExpressionAttributeNames"
          | "Key",
      >,
      "TableName",
  >
Returns Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>
- Defined in src/EntityClient/EntityClient.ts:309
getItem<ET extends string | number | symbol>(
entityToken: ET,
options: MakeOptional<GetCommandInput, "TableName">,
): Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>
Token-aware getItem overloads (records). Strip keys in handlers when needed via entityManager.removeKeys.

Token-aware with tuple projection (attributes as const) -> projected DB record
Type Parameters
- ET extends string | number | symbol
Parameters
- entityToken: ET
- options: MakeOptional<GetCommandInput, "TableName">
Returns Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>
- Defined in src/EntityClient/EntityClient.ts:328

getItems

getItems<ET extends string | number | symbol, A extends readonly string[]>(
    entityToken: ET,
    keys: EntityKey<C>[],
    attributes: A,
    options?: BatchGetOptions,
): Promise<
    {
        items: EntityRecordPartial<C, ET, A>[];
        outputs: BatchGetCommandOutput[];
    },
>
Gets multiple items from a DynamoDB table in batches (records). Token-aware; strip keys in handlers when needed via entityManager.removeKeys.
Type Parameters
- ET extends string | number | symbol
- A extends readonly string[]
Parameters
- entityToken: ET
- keys: EntityKey<C>[]
  Array of EntityKey.
- attributes: A
  Optional list of attributes to project.
- Optionaloptions: BatchGetOptions
  BatchGetOptions.
Returns Promise<
    {
        items: EntityRecordPartial<C, ET, A>[];
        outputs: BatchGetCommandOutput[];
    },
>
- Defined in src/EntityClient/EntityClient.ts:405
getItems<ET extends string | number | symbol>(
    entityToken: ET,
    keys: EntityKey<C>[],
    attributes: string[],
    options?: BatchGetOptions,
): Promise<
    { items: EntityRecord<C, ET>[]; outputs: BatchGetCommandOutput[] },
>
Gets multiple items from a DynamoDB table in batches (records). Token-aware; strip keys in handlers when needed via entityManager.removeKeys.
Type Parameters
- ET extends string | number | symbol
Parameters
- entityToken: ET
- keys: EntityKey<C>[]
  Array of EntityKey.
- attributes: string[]
  Optional list of attributes to project.
- Optionaloptions: BatchGetOptions
  BatchGetOptions.
Returns Promise<{ items: EntityRecord<C, ET>[]; outputs: BatchGetCommandOutput[] }>
- Defined in src/EntityClient/EntityClient.ts:415
getItems<ET extends string | number | symbol>(
    entityToken: ET,
    keys: EntityKey<C>[],
    options?: BatchGetOptions,
): Promise<
    { items: EntityRecord<C, ET>[]; outputs: BatchGetCommandOutput[] },
>
Gets multiple items from a DynamoDB table in batches (records). Token-aware; strip keys in handlers when needed via entityManager.removeKeys.
Type Parameters
- ET extends string | number | symbol
Parameters
- entityToken: ET
- keys: EntityKey<C>[]
  Array of EntityKey.
- Optionaloptions: BatchGetOptions
  BatchGetOptions.
Returns Promise<{ items: EntityRecord<C, ET>[]; outputs: BatchGetCommandOutput[] }>
- Defined in src/EntityClient/EntityClient.ts:425

purgeItems

purgeItems(options?: BatchWriteOptions): Promise<number>
Purge all items from a DynamoDB table.
Parameters
- Optionaloptions: BatchWriteOptions
  BatchWriteOptions.
Returns Promise<number>
Number of items purged.
- Defined in src/EntityClient/EntityClient.ts:238

putItem

putItem(
item: EntityRecord<C, EntityToken<C>>,
options?: MakeOptional<Omit<PutCommandInput, "Item">, "TableName">,
): Promise<PutCommandOutput>
Puts an item to a DynamoDB table.
Parameters
- item: EntityRecord<C, EntityToken<C>>
  EntityRecord object (storage-facing).
- Optionaloptions: MakeOptional<Omit<PutCommandInput, "Item">, "TableName">
  PutCommandInput with Item omitted; TableName optional.
Returns Promise<PutCommandOutput>
- Defined in src/EntityClient/EntityClient.ts:135
putItem(
    options: MakeOptional<
        ReplaceKey<PutCommandInput, "Item", EntityRecord<C, EntityToken<C>>>,
        "TableName",
    >,
): Promise<PutCommandOutput>
Puts an item to a DynamoDB table.
Parameters
- options: MakeOptional<
  ReplaceKey<PutCommandInput, "Item", EntityRecord<C, EntityToken<C>>>,
  "TableName",
  >
  PutCommandInput; TableName optional.
Returns Promise<PutCommandOutput>
- Defined in src/EntityClient/EntityClient.ts:146

putItems

putItems(
items: EntityRecord<C, EntityToken<C>>[],
options?: BatchWriteOptions,
): Promise<BatchWriteCommandOutput[]>
Puts multiple items to a DynamoDB table in batches.
Parameters
- items: EntityRecord<C, EntityToken<C>>[]
  Array of EntityRecord.
- Optionaloptions: BatchWriteOptions
  BatchWriteOptions.
Returns Promise<BatchWriteCommandOutput[]>
- Defined in src/EntityClient/EntityClient.ts:211

transactDeleteItems

transactDeleteItems(keys: EntityKey<C>[]): Promise<TransactWriteCommandOutput>
Deletes multiple items as a single transaction.
Parameters
- keys: EntityKey<C>[]
  Array of EntityKey.
Returns Promise<TransactWriteCommandOutput>
- Defined in src/EntityClient/EntityClient.ts:258

transactPutItems

transactPutItems(
items: EntityRecord<C, EntityToken<C>>[],
): Promise<TransactWriteCommandOutput>
Puts multiple items as a single transaction.
Parameters
- items: EntityRecord<C, EntityToken<C>>[]
  Array of EntityRecord.
Returns Promise<TransactWriteCommandOutput>
- Defined in src/EntityClient/EntityClient.ts:247

Class EntityClient<C, CF>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EntityClient<C, CF>

Properties

ReadonlybatchProcessOptions

Readonlyclient

Readonlydoc

ReadonlyentityManager

Readonlylogger

ReadonlytableName

Methods

createTable

Parameters

Returns Promise< { createTableCommandOutput: CreateTableCommandOutput; waiterResult: WaiterResult; },>

deleteItem

Parameters

Returns Promise<DeleteCommandOutput>

Parameters

Returns Promise<DeleteCommandOutput>

deleteItems

Parameters

Returns Promise<BatchWriteCommandOutput[]>

deleteTable

Parameters

Returns Promise< { deleteTableCommandOutput: DeleteTableCommandOutput; waiterResult: WaiterResult; },>

getItem

Type Parameters

Parameters

Returns Promise< Omit<GetCommandOutput, "Item"> & { Item?: EntityRecordPartial<C, ET, A>; },>

Type Parameters

Parameters

Returns Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>

Type Parameters

Parameters

Returns Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>

Type Parameters

Parameters

Returns Promise<Omit<GetCommandOutput, "Item"> & { Item?: EntityRecord<C, ET> }>

getItems

Type Parameters

Parameters

Returns Promise< { items: EntityRecordPartial<C, ET, A>[]; outputs: BatchGetCommandOutput[]; },>

Type Parameters

Parameters

Returns Promise<{ items: EntityRecord<C, ET>[]; outputs: BatchGetCommandOutput[] }>

Type Parameters

Parameters

Returns Promise<{ items: EntityRecord<C, ET>[]; outputs: BatchGetCommandOutput[] }>

purgeItems

Parameters

Returns Promise<number>

putItem

Parameters

Returns Promise<PutCommandOutput>

Parameters

Returns Promise<PutCommandOutput>

putItems

Parameters

Returns Promise<BatchWriteCommandOutput[]>

transactDeleteItems

Parameters

Returns Promise<TransactWriteCommandOutput>

transactPutItems

Parameters

Returns Promise<TransactWriteCommandOutput>

Settings

On This Page

`Readonly`batchProcessOptions

`Readonly`client

`Readonly`doc

`Readonly`entityManager

`Readonly`logger

`Readonly`tableName

Returns Promise<
{
createTableCommandOutput: CreateTableCommandOutput;
waiterResult: WaiterResult;
},
>

Returns Promise<
{
deleteTableCommandOutput: DeleteTableCommandOutput;
waiterResult: WaiterResult;
},
>

Returns Promise<
Omit<GetCommandOutput, "Item"> & {
Item?: EntityRecordPartial<C, ET, A>;
},
>

Returns Promise<
{
items: EntityRecordPartial<C, ET, A>[];
outputs: BatchGetCommandOutput[];
},
>