interface DynamoDatabaseOptions
Since 0.1.0

The arm selecting the DynamoDB adapter over the AWS SDK v3 client.

options.region is required by the union unless options.client is supplied, so a registration that forgets both is a compile error instead of a connect() throw — the same guarantee the 'custom' arm gives adapter. The client is supplied inject-or-lazy (§12.2 of AI_GUIDELINES): client is an already-constructed structural IDynamoClient, and absent it the adapter performs a literal import('npm:@aws-sdk/client-dynamodb@^3') at connect time.

Examples

Example 1

import { DatabasePlugin } from '@setu-ts/database-plugin';

DatabasePlugin({
  type: 'dynamodb',
  options: { region: 'us-east-1' },
});

Properties

readonly
type: "dynamodb"

Selects the DynamoDB arm.

DynamoDB adapter configuration; region (or client) is required.

Usage

import { type DynamoDatabaseOptions } from "database-plugin/src/index.ts";