インターフェイス FieldDefinition<Name, FieldTypeDefinition>

フィールド名と Field Type を維持する schema 項目です。

interface FieldDefinition<
    Name extends string = string,
    FieldTypeDefinition extends FieldTypeLike = FieldTypeLike,
> {
    allowNull?: boolean;
    autoIncrement?: boolean;
    column?: string;
    defaultValue?: FieldTypeValue<FieldTypeDefinition>;
    name: Name;
    primaryKey?: boolean;
    type?: FieldTypeDefinition;
    validators?:
        | FieldValidator<FieldTypeValue<FieldTypeDefinition>>
        | readonly FieldValidator<FieldTypeValue<FieldTypeDefinition>>[];
}

型パラメーター

Name extends string = string
FieldTypeDefinition extends FieldTypeLike = FieldTypeLike

階層 (theme_hierarchy_view_summary)

SchemaFieldDefinition
- FieldDefinition

インデックス

プロパティ

allowNull? autoIncrement? column? defaultValue? name primaryKey? type? validators?

プロパティ

`オプション` `読み取り専用`allowNull

allowNull?: boolean

推論されたアプリケーション値に null が含まれるかどうかです。

`オプション` `読み取り専用`autoIncrement

autoIncrement?: boolean

insert 時にストレージバックエンドがこのフィールドを生成するかどうかです。

`オプション` `読み取り専用`column

column?: string

ストレージ列名です。既定値は name です。

`オプション` `読み取り専用`defaultValue

defaultValue?: FieldTypeValue<FieldTypeDefinition>

新しく構築したデータ行でこのフィールドが省略された場合に使用するアプリケーション値です。

`読み取り専用`name

name: Name

schema の推論で維持される、論理プロパティ名のリテラルです。

`オプション` `読み取り専用`primaryKey

primaryKey?: boolean

主キー検索にこのフィールドを使用するかどうかです。

`オプション` `読み取り専用`type

type?: FieldTypeDefinition

値の推論に維持される具体的な Field Type です。

`オプション` `読み取り専用`validators

validators?:
| FieldValidator<FieldTypeValue<FieldTypeDefinition>>
| readonly FieldValidator<FieldTypeValue<FieldTypeDefinition>>[]

推論されたアプリケーション値を受け取る validator です。