@typia/website
    Preparing search index...

    Interface IArray

    Array type info.

    interface IArray {
        deprecated?: boolean;
        description?: string;
        example?: any;
        examples?: Record<string, any>;
        items: OpenApi.IJsonSchema;
        maxItems?: number;
        minItems?: number;
        title?: string;
        type: "array";
        uniqueItems?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    deprecated? description? example? examples? items maxItems? minItems? title? type uniqueItems?

    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.

    items: OpenApi.IJsonSchema

    Items type info.

    The items means the type of the array elements. In other words, it is the type schema info of the T in the TypeScript array type Array<T>.

    maxItems?: number

    Maximum items restriction.

    Restriction of maximum number of items in the array.

    minItems?: number

    Minimum items restriction.

    Restriction of minimum number of items in the array.

    title?: string

    Title of the schema.

    type: "array"

    Discriminator value of the type.

    uniqueItems?: boolean

    Unique items restriction.

    If this property value is true, target array must have unique items.

    Settings

    Member Visibility

    On This Page

    Properties