Kfg Documentation
    Preparing search index...

    Interface CustomOptions<Default>

    Custom metadata properties that can be added to a schema.

    interface CustomOptions<Default = any> {
        createms?: boolean;
        custom_error?: string;
        default?: Default;
        description?: string;
        important?: boolean;
        initial_save?: boolean;
        prop?: string;
        refines?: ((value: unknown) => string | boolean)[];
    }

    Type Parameters

    • Default = any
    Index

    Properties

    createms? custom_error? default? description? important? initial_save? prop? refines?

    Properties

    createms?: boolean
    custom_error?: string

    Custom validation error message for this field. When set and the field fails validation, the error shows this message instead of the default "expected X, received Y" detail.

    default?: Default
    description?: string
    important?: boolean
    initial_save?: boolean
    prop?: string
    refines?: ((value: unknown) => string | boolean)[]

    Settings

    Member Visibility

    On This Page

    Properties