Interface IString

String type schema info.

interface IString {
    deprecated?: boolean;
    description?: string;
    enum?: (null | string)[];
    example?: any;
    examples?: Record<string, any>;
    nullable?: boolean;
    type: "string";
}

Hierarchy (View Summary)

Properties

deprecated? description? enum? example? examples? nullable? type

Properties

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Warning

document of Gemini says not supported, but cannot sure

Optionaldescription

description?: string

Detailed description of the schema.

Optionalenum

enum?: (null | string)[]

Enumeration values.

Optionalexample

example?: any

Example value.

Warning

document of Gemini says not supported, but cannot sure

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

Warning

document of Gemini says not supported, but cannot sure

Optionalnullable

nullable?: boolean

Whether to allow null value or not.

type

type: "string"

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties