@typia/website
    Preparing search index...

    Interface IBoolean

    Boolean type schema info.

    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 (View Summary)

    Index

    Properties

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

    Properties

    default?: null | boolean

    Default value.

    deprecated?: boolean

    Whether the type is deprecated or not.

    description?: string

    Detailed description of the schema.

    enum?: (null | boolean)[]

    Enumeration values.

    example?: any

    Example value.

    examples?: Record<string, any>

    List of example values as key-value pairs.

    nullable?: boolean

    Whether to allow null value or not.

    title?: string

    Title of the schema.

    type: "boolean"

    Discriminator value of the type.

    Settings

    Member Visibility

    On This Page

    Properties