Interface IArray

Array type schema info.

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

Hierarchy (View Summary)

Properties

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

Properties

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

items

items: ILlmSchemaV3

Items type schema 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>.

OptionalmaxItems

maxItems?: number

Maximum items restriction.

Restriction of maximum number of items in the array.

OptionalminItems

minItems?: number

Minimum items restriction.

Restriction of minimum number of items in the array.

Optionalnullable

nullable?: boolean

Whether to allow null value or not.

Optionaltitle

title?: string

Title of the schema.

type

type: "array"

Discriminator value of the type.

OptionaluniqueItems

uniqueItems?: boolean

Unique items restriction.

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

Settings

Member Visibility

On This Page

Properties