Interface TEnum<T>

interface TEnum<T> {
    $id?: string;
    $schema?: string;
    [Hint]: "Enum";
    [Kind]: "Union";
    [OptionalKind]?: string;
    [ReadonlyKind]?: string;
    anyOf: TLiteral<T[keyof T]>[];
    default?: any;
    description?: string;
    examples?: any;
    params: unknown[];
    readOnly?: boolean;
    static: T[keyof T];
    title?: string;
    writeOnly?: boolean;
}

Type Parameters

  • T extends Record<string, string | number> = Record<string, string | number>

Hierarchy (view full)

Properties

$id? $schema? [Hint] [Kind] [OptionalKind]? [ReadonlyKind]? anyOf default? description? examples? params readOnly? static title? writeOnly?

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

[Hint]

[Hint]: "Enum"

[Kind]

[Kind]: "Union"

Optional[OptionalKind]

[OptionalKind]?: string

Optional[ReadonlyKind]

[ReadonlyKind]?: string

anyOf

anyOf: TLiteral<T[keyof T]>[]

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

params

params: unknown[]

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

static

static: T[keyof T]

Optionaltitle

title?: string

Title of this schema

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties