Interface IBoolean

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

Hierarchy

  • __ISignificant<"boolean">
    • IBoolean

Properties

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

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?: Record<string, any>

List of example values as key-value pairs.

Optionalnullable

nullable?: boolean

Optionaltitle

title?: string

Title of the schema.

type

type: "boolean"

Settings

Member Visibility

On This Page

Properties