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 full)

Indexable

  • [prop: string]: any

Properties

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

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

Optionaltitle

title?: string

Title of this schema

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties