dynamodb-toolbox/dist/cjs/schema/types/schemaProps.d.ts

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

import type { Validator } from './validator.js';
/**
 * Tag for optional values
 */
export type Never = 'never';
/**
 * Tag for required at least once values
 */
export type AtLeastOnce = 'atLeastOnce';
/**
 * Tag for always required values
 */
export type Always = 'always';
/**
 * Available values for schema `required` properties
 */
export type SchemaRequiredProp = Never | AtLeastOnce | Always;
export interface SchemaProps {
    required?: SchemaRequiredProp;
    hidden?: boolean;
    key?: boolean;
    savedAs?: string;
    keyDefault?: unknown;
    putDefault?: unknown;
    updateDefault?: unknown;
    keyLink?: unknown;
    putLink?: unknown;
    updateLink?: unknown;
    keyValidator?: Validator;
    putValidator?: Validator;
    updateValidator?: Validator;
}