Interface IConstant

interface IConstant {
    const: string | number | boolean;
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: any[] | Record<string, any>;
    nullable?: boolean;
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}

Hierarchy (View Summary)

Properties

const deprecated? description? example? examples? nullable? readOnly? title? writeOnly?

Properties

const

const: string | number | boolean

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: any[] | Record<string, any>

Optionalnullable

nullable?: boolean

OptionalreadOnly

readOnly?: boolean

Whether the property is read-only.

Optionaltitle

title?: string

Title of the schema.

OptionalwriteOnly

writeOnly?: boolean

Whether the property is write-only.

Settings

Member Visibility

On This Page

Properties