Interface IString

String type info.

interface IString {
    deprecated?: boolean;
    description?: string;
    enum?: string[];
    example?: any;
    examples?: Record<string, any>;
    title?: string;
    type: "string";
}

Hierarchy (View Summary)

Properties

deprecated? description? enum? example? examples? title? type

Properties

Optionaldeprecated

deprecated?: boolean

Whether the type is deprecated or not.

Optionaldescription

description?: string

Detailed description of the schema.

Optionalenum

enum?: string[]

Enumeration values.

Optionalexample

example?: any

Example value.

Optionalexamples

examples?: Record<string, any>

List of example values as key-value pairs.

Optionaltitle

title?: string

Title of the schema.

type

type: "string"

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties