Interface IArray

Array type schema info.

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

Hierarchy (View Summary)

Properties

deprecated? description? example? examples? items nullable? title? type

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: IGeminiSchema

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>.

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.

Settings

Member Visibility

On This Page

Properties