Toshihiko
    Preparing search index...

    Interface SchemaFieldDefinition

    The common shape accepted for one entry in a Toshihiko schema.

    Use FieldDefinition when a reusable declaration should retain its literal field name and concrete Field Type. This broader interface is the structural constraint used by SchemaDefinition.

    interface SchemaFieldDefinition {
        allowNull?: boolean;
        autoIncrement?: boolean;
        column?: string;
        defaultValue?: DataValue;
        name: string;
        primaryKey?: boolean;
        type?: FieldTypeLike;
        validators?: FieldValidator<never> | readonly FieldValidator<never>[];
    }

    Hierarchy (View Summary)

    Index
    allowNull? autoIncrement? column? defaultValue? name primaryKey? type? validators?
    allowNull?: boolean

    Whether the application value may be null.

    autoIncrement?: boolean

    Whether the storage backend generates this field on insert.

    column?: string

    Storage column name; defaults to name.

    defaultValue?: DataValue

    Application value used when a newly built row omits this field.

    name: string

    Logical property name exposed on Yukari rows.

    primaryKey?: boolean

    Whether the field participates in primary-key lookups and row locators.

    type?: FieldTypeLike

    Value conversion contract; defaults to Type.String.

    validators?: FieldValidator<never> | readonly FieldValidator<never>[]

    One validator or a list executed before writes.

    Settings
    Member Visibility

    On This Page
    Properties