@typia/website
    Preparing search index...

    Interface IObject

    Common attributes for object types.

    interface IObject {
        deprecated?: boolean;
        description?: string;
        example?: any;
        examples?: Record<string, any>;
        title?: string;
        type: "object";
    }

    Hierarchy (View Summary)

    Index

    Properties

    deprecated? description? example? examples? title? type

    Properties

    deprecated?: boolean

    Whether the type is deprecated or not.

    description?: string

    Detailed description of the schema.

    example?: any

    Example value.

    examples?: Record<string, any>

    List of example values as key-value pairs.

    title?: string

    Title of the schema.

    type: "object"

    Discriminator value of the type.

    Settings

    Member Visibility

    On This Page

    Properties