Toshihiko
    検索インデックスを準備しています...

    インターフェイス Field<Definition>

    コンパイル済み schema の 1 項目を表す実行時オブジェクトです。

    interface Field<
        Definition extends SchemaFieldDefinition = SchemaFieldDefinition,
    > {
        allowNull: boolean;
        autoIncrement: boolean;
        column: string;
        default: FieldDefinitionValue<Definition> | undefined;
        equal: (
            left: FieldDefinitionValue<Definition>,
            right: FieldDefinitionValue<Definition>,
        ) => boolean;
        name: Definition["name"];
        options: Readonly<Definition>;
        primaryKey: boolean;
        type: FieldTypeFromDefinition<Definition>;
        validators: readonly FieldValidator<
            FieldTypeValue<FieldTypeFromDefinition<Definition>>,
        >[];
        get defaultValue(): FieldDefinitionValue<Definition> | undefined;
        get needQuotes(): boolean;
        parse(
            value: ReturnType<FieldTypeFromDefinition<Definition>["restore"]>,
        ): FieldDefinitionValue<Definition>;
        restore(
            value: FieldDefinitionValue<Definition>,
        ): ReturnType<FieldTypeFromDefinition<Definition>["restore"]>;
        toJSON(
            value: FieldDefinitionValue<Definition>,
        ): FieldDefinitionJsonValue<Definition>;
    }

    型パラメーター

    インデックス
    allowNull autoIncrement column default equal name options primaryKey type validators
    defaultValue needQuotes
    parse restore toJSON
    allowNull: boolean

    フィールドが null を受け付けるかどうかです。

    autoIncrement: boolean

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

    column: string

    Adapter が使用するストレージ列名です。

    default: FieldDefinitionValue<Definition> | undefined

    解決後の schema または Field Type の既定値です。

    equal: (
        left: FieldDefinitionValue<Definition>,
        right: FieldDefinitionValue<Definition>,
    ) => boolean

    Field Type または厳密等価を使用して、2 個のアプリケーション値を比較します。

    name: Definition["name"]

    Yukari のデータ行に公開する論理プロパティ名です。

    options: Readonly<Definition>

    正規化済みのフィールドオプションです。

    primaryKey: boolean

    データ行の特定条件にこのフィールドを使用するかどうかです。

    type: FieldTypeFromDefinition<Definition>

    parse()、restore()、比較、JSON 変換に使用する Field Type です。

    validators: readonly FieldValidator<
        FieldTypeValue<FieldTypeFromDefinition<Definition>>,
    >[]

    正規化済みの validator 一覧です。

    • get needQuotes(): boolean

      SQL Adapter が restore() 後の値を引用符で囲む必要があるかどうかです。

      戻り値 boolean

    • ストレージ値をアプリケーション上の表現へ変換します。

      パラメータ

      • value: ReturnType<FieldTypeFromDefinition<Definition>["restore"]>

        ストレージバックエンドが返した値です。

      戻り値 FieldDefinitionValue<Definition>

      parse 後のアプリケーション値です。

    • アプリケーション値をストレージ上の表現へ変換します。

      パラメータ

      • value: FieldDefinitionValue<Definition>

        Yukari フィールドの現在値です。

      戻り値 ReturnType<FieldTypeFromDefinition<Definition>["restore"]>

      Adapter へ渡せる状態の値です。

    テーマ設定
    メンバーの可視性

    このページ
    プロパティ
    アクセッサー
    メソッド