dynamodb-toolbox/dist/esm/table/types/indexes.d.ts

Lightweight and type-safe query builder for DynamoDB and TypeScript.

import type { Key } from './key.js';
export interface LocalIndex {
    type: 'local';
    partitionKey?: undefined;
    sortKey: Key;
}
export interface GlobalIndex {
    type: 'global';
    partitionKey: Key;
    sortKey?: Key;
}
/**
 * Define an index of a Table
 *
 * @param KEY_NAME Key attribute name
 * @param KEY_TYPE Key value type
 * @return Key
 */
export type Index = LocalIndex | GlobalIndex;