Interface TObject<T>

interface TObject<T> {
    [Hint]?: string;
    [Kind]: "Object";
    [OptionalKind]?: string;
    [ReadonlyKind]?: string;
    $id?: string;
    $schema?: string;
    additionalProperties?: TAdditionalProperties;
    default?: any;
    description?: string;
    examples?: any;
    maxProperties?: number;
    minProperties?: number;
    params: unknown[];
    properties: T;
    readOnly?: boolean;
    required?: string[];
    static: Evaluate<Readonly<Partial<Pick<{
        [K in string | number | symbol]: Static<T[K], unknown[]>
    }, ReadonlyOptionalPropertyKeys<T>>>> & Readonly<Pick<{
        [K in string | number | symbol]: Static<T[K], unknown[]>
    }, ReadonlyPropertyKeys<T>>> & Partial<Pick<{
        [K in string | number | symbol]: Static<T[K], unknown[]>
    }, OptionalPropertyKeys<T>>> & Required<Pick<{
        [K in string | number | symbol]: Static<T[K], unknown[]>
    }, Exclude<keyof T, ReadonlyOptionalPropertyKeys<T> | ReadonlyPropertyKeys<T> | OptionalPropertyKeys<T>>>>>;
    title?: string;
    type: "object";
    writeOnly?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional[Hint]

[Hint]?: string

[Kind]

[Kind]: "Object"

Optional[OptionalKind]

[OptionalKind]?: string

Optional[ReadonlyKind]

[ReadonlyKind]?: string

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

OptionaladditionalProperties

additionalProperties?: TAdditionalProperties

Additional property constraints for this object

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

OptionalmaxProperties

maxProperties?: number

The maximum number of properties allowed on this object

OptionalminProperties

minProperties?: number

The minimum number of properties allowed on this object

params

params: unknown[]

properties

properties: T

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

Optionalrequired

required?: string[]

static

static: Evaluate<Readonly<Partial<Pick<{
    [K in string | number | symbol]: Static<T[K], unknown[]>
}, ReadonlyOptionalPropertyKeys<T>>>> & Readonly<Pick<{
    [K in string | number | symbol]: Static<T[K], unknown[]>
}, ReadonlyPropertyKeys<T>>> & Partial<Pick<{
    [K in string | number | symbol]: Static<T[K], unknown[]>
}, OptionalPropertyKeys<T>>> & Required<Pick<{
    [K in string | number | symbol]: Static<T[K], unknown[]>
}, Exclude<keyof T, ReadonlyOptionalPropertyKeys<T> | ReadonlyPropertyKeys<T> | OptionalPropertyKeys<T>>>>>

Optionaltitle

title?: string

Title of this schema

type

type: "object"

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties