Interface __ISignificant<Type>

interface __ISignificant<Type extends string> {
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: any[];
    readOnly?: boolean;
    title?: string;
    type: Type;
    "x-nullable"?: boolean;
}

Type Parameters

  • Type extends string

Hierarchy (View Summary)

Properties

deprecated? description? example? examples? readOnly? title? type x-nullable?

Properties

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[]

OptionalreadOnly

readOnly?: boolean

Whether the property is read-only.

Optionaltitle

title?: string

Title of the schema.

type

type: Type

Optionalx-nullable

"x-nullable"?: boolean

Settings

Member Visibility

On This Page

Properties