Interface TRecord<Key, Type>

interface TRecord<Key, Type> {
    $id?: string;
    $schema?: string;
    [Hint]?: string;
    [Kind]: "Record";
    [OptionalKind]?: string;
    [ReadonlyKind]?: string;
    additionalProperties: TAdditionalProperties;
    default?: any;
    description?: string;
    examples?: any;
    params: unknown[];
    patternProperties: {
        [pattern: string]: Type;
    };
    readOnly?: boolean;
    static: Evaluate<{
        [_ in PropertyKey]: (Type & {
            params: unknown[];
        })["static"]
    }>;
    title?: string;
    type: "object";
    writeOnly?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

Optional[Hint]

[Hint]?: string

[Kind]

[Kind]: "Record"

Optional[OptionalKind]

[OptionalKind]?: string

Optional[ReadonlyKind]

[ReadonlyKind]?: string

additionalProperties

additionalProperties: TAdditionalProperties

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[]

patternProperties

patternProperties: {
    [pattern: string]: Type;
}

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

static

static: Evaluate<{
    [_ in PropertyKey]: (Type & {
        params: unknown[];
    })["static"]
}>

Optionaltitle

title?: string

Title of this schema

type

type: "object"

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties