Interface IBoolean

interface IBoolean {
    default?: null | boolean;
    deprecated?: boolean;
    description?: string;
    enum?: (null | boolean)[];
    example?: any;
    examples?: any[] | Record<string, any>;
    nullable?: boolean;
    readOnly?: boolean;
    title?: string;
    type: "boolean";
    writeOnly?: boolean;
}

Hierarchy (View Summary)

Properties

default? deprecated? description? enum? example? examples? nullable? readOnly? title? type writeOnly?

Properties

Optionaldefault

default?: null | boolean

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalenum

enum?: (null | boolean)[]

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.

type

type: "boolean"

Discriminator value of the type.

OptionalwriteOnly

writeOnly?: boolean

Whether the property is write-only.

Settings

Member Visibility

On This Page

Properties