Kfg Documentation
    Preparing search index...

    Interface SchemaOptions

    interface SchemaOptions {
        $id?: string;
        $schema?: string;
        default?: any;
        description?: string;
        examples?: any;
        readOnly?: boolean;
        title?: string;
        writeOnly?: boolean;
        [prop: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [prop: string]: any
    Index

    Properties

    $id? $schema? default? description? examples? readOnly? title? writeOnly?

    Properties

    $id?: string

    Id for this schema

    $schema?: string
    default?: any

    Default value for this schema

    description?: string

    Description of this schema

    examples?: any

    Example values matching this schema

    readOnly?: boolean

    Optional annotation for readOnly

    title?: string

    Title of this schema

    writeOnly?: boolean

    Optional annotation for writeOnly

    Settings

    Member Visibility

    On This Page

    Properties