Interface TLiteral<T>

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

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional[Hint]

[Hint]?: string

[Kind]

[Kind]: "Literal"

Optional[OptionalKind]

[OptionalKind]?: string

Optional[ReadonlyKind]

[ReadonlyKind]?: string

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

const

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

Optionaltitle

title?: string

Title of this schema

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties