Documentation
    Preparing search index...

    Interface IObject

    Object type.

    interface IObject {
        additionalProperties?: boolean | OpenApiV3_1.IJsonSchema;
        deprecated?: boolean;
        description?: string;
        example?: any;
        examples?: any[] | Record<string, any>;
        maxProperties?: number;
        minProperties?: number;
        nullable?: boolean;
        properties?: Record<string, OpenApiV3_1.IJsonSchema>;
        readOnly?: boolean;
        required?: string[];
        title?: string;
        type: "object";
        writeOnly?: boolean;
    }

    Hierarchy

    Index

    Properties

    additionalProperties? deprecated? description? example? examples? maxProperties? minProperties? nullable? properties? readOnly? required? title? type writeOnly?

    Properties

    additionalProperties?: boolean | OpenApiV3_1.IJsonSchema

    Additional properties schema.

    deprecated?: boolean

    Whether this type is deprecated.

    When true, indicates the type should no longer be used and may be removed in future versions. Set via the @deprecated JSDoc tag.

    description?: string

    Detailed description of the schema.

    Full documentation for the type, explaining its purpose, constraints, and usage. Extracted from JSDoc comment body. Supports markdown formatting in many JSON Schema consumers.

    example?: any

    Single example value for the schema.

    A representative value that conforms to the schema, useful for documentation and testing. Set via the @example JSDoc tag.

    examples?: any[] | Record<string, any>

    Example values.

    maxProperties?: number

    Maximum properties.

    minProperties?: number

    Minimum properties.

    nullable?: boolean

    Whether nullable.

    properties?: Record<string, OpenApiV3_1.IJsonSchema>

    Property schemas.

    readOnly?: boolean

    Whether the property is read-only.

    When true, the property should not be modified by clients and is typically set by the server. Useful for generated IDs, timestamps, etc.

    required?: string[]

    Required property names.

    title?: string

    Short title for the schema.

    A brief, human-readable name for the type. Typically extracted from the first line of a JSDoc comment or the @title tag.

    type: "object"
    writeOnly?: boolean

    Whether the property is write-only.

    When true, the property is accepted on input but never returned in responses. Common for sensitive data like passwords.

    Settings

    Member Visibility

    On This Page

    Properties