Interface ObjectOptions

interface ObjectOptions {
    $id?: string;
    $schema?: string;
    additionalProperties?: TAdditionalProperties;
    default?: any;
    description?: string;
    examples?: any;
    maxProperties?: number;
    minProperties?: number;
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}

Hierarchy (view full)

Properties

$id? $schema? additionalProperties? default? description? examples? maxProperties? minProperties? readOnly? title? writeOnly?

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

OptionaladditionalProperties

additionalProperties?: TAdditionalProperties

Additional property constraints for this object

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

OptionalmaxProperties

maxProperties?: number

The maximum number of properties allowed on this object

OptionalminProperties

minProperties?: number

The minimum number of properties allowed on this object

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