Interface ModelManifest<Schema, HasRevisions, StaticMethods, InstanceMethods>

Model manifest definition - declarative model configuration Used by createModel() to generate properly typed model handles

Note: Relation types are inferred via Manifest['relations'] property access, not via generic parameter, enabling as const satisfies ModelManifest pattern.

interface ModelManifest<
    Schema extends
        Record<string, ModelSchemaField> = Record<string, ModelSchemaField>,
    HasRevisions extends boolean = boolean,
    StaticMethods extends object = EmptyStaticMethods,
    InstanceMethods extends object = Record<never, InstanceMethod>,
> {
    camelToSnake?: Record<string, string>;
    hasRevisions: HasRevisions;
    instanceMethods?: InstanceMethods & ThisType<
        InferInstance<
            ModelManifest<Schema, HasRevisions, StaticMethods, InstanceMethods>,
        >,
    >;
    relations?: readonly RelationDefinition[];
    schema: Schema;
    staticMethods?: StaticMethods & ThisType<
        InferConstructor<
            ModelManifest<Schema, HasRevisions, StaticMethods, InstanceMethods>,
        >,
    >;
    tableName: string;
    views?: Record<string, ModelViewDefinition<ModelInstance, JsonObject>>;
}

Type Parameters

Properties

camelToSnake? hasRevisions instanceMethods? relations? schema staticMethods? tableName views?

Properties

OptionalcamelToSnake

camelToSnake?: Record<string, string>

hasRevisions

hasRevisions: HasRevisions

OptionalinstanceMethods

instanceMethods?: InstanceMethods & ThisType<
    InferInstance<
        ModelManifest<Schema, HasRevisions, StaticMethods, InstanceMethods>,
    >,
>

Optionalrelations

relations?: readonly RelationDefinition[]

schema

schema: Schema

OptionalstaticMethods

staticMethods?: StaticMethods & ThisType<
    InferConstructor<
        ModelManifest<Schema, HasRevisions, StaticMethods, InstanceMethods>,
    >,
>

tableName

tableName: string

Optionalviews

views?: Record<string, ModelViewDefinition<ModelInstance, JsonObject>>

Settings

Member Visibility

On This Page

Properties