Interface __ISignificant<Type>

Significant attributes that can be applied to the most types.

interface __ISignificant<Type extends string> {
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    nullable?: boolean;
    type: Type;
}

Type Parameters

  • Type extends string

Hierarchy (View Summary)

Properties

deprecated? description? 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.

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

Discriminator value of the type.

Settings

Member Visibility

On This Page

Properties