@nerdware/ddb-single-table/dist/cjs/Schema/types/SchemaMetadata.d.ts

A schema-based DynamoDB modeling tool, high-level API, and type-generator built to supercharge single-table designs!⚡

import type { ValueOf, OverrideProperties } from "type-fest";
/**
 * Dictionary of supported `Schema` types.
 */
export declare const SCHEMA_TYPE: {
    readonly MODEL_SCHEMA: "ModelSchema";
    readonly TABLE_KEYS_SCHEMA: "TableKeysSchema";
};
/**
 * Union of supported `schemaType` values.
 */
export type SchemaType = ValueOf<typeof SCHEMA_TYPE>;
/**
 * Base type for `Schema` metadata properties.
 */
export type SchemaMetadata = {
    schemaType: SchemaType;
    name?: string;
    version?: string;
};
/**
 * `ModelSchema` {@link SchemaMetadata|metadata properties}.
 */
export type ModelSchemaMetadata = OverrideProperties<SchemaMetadata, {
    name: string;
    schemaType?: "ModelSchema";
}>;
/**
 * `TableKeysSchema` {@link SchemaMetadata|metadata properties}.
 */
export type TableKeysSchemaMetadata = OverrideProperties<SchemaMetadata, {
    schemaType?: "TableKeysSchema";
}>;
//# sourceMappingURL=SchemaMetadata.d.ts.map