Interface Reference

interface Reference {
    $comment?: string;
    $ref: string;
    default?: any;
    description?: string;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
}

Hierarchy (View Summary)

Properties

$comment? $ref default? description? examples? readOnly? title?

Properties

Optional$comment

$comment?: string

Internal comment

$ref

$ref: string

Optionaldefault

default?: any

Default attribute value

Optionaldescription

description?: string

Attribute description

Optionalexamples

examples?: any[]

List of attribute examples

OptionalreadOnly

readOnly?: boolean

Non-editable schema

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties