Interface TFunction<T, U>

interface TFunction<T, U> {
    $id?: string;
    $schema?: string;
    [Hint]?: string;
    [Kind]: "Function";
    [OptionalKind]?: string;
    [ReadonlyKind]?: string;
    default?: any;
    description?: string;
    examples?: any;
    parameters: T;
    params: unknown[];
    readOnly?: boolean;
    returns: U;
    static: ((...param: StaticParameters<T, unknown[], []>) => (U & {
        params: unknown[];
    })["static"]);
    title?: string;
    type: "Function";
    writeOnly?: boolean;
}

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

Optional[Hint]

[Hint]?: string

[Kind]

[Kind]: "Function"

Optional[OptionalKind]

[OptionalKind]?: string

Optional[ReadonlyKind]

[ReadonlyKind]?: string

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

parameters

parameters: T

params

params: unknown[]

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

returns

returns: U

static

static: ((...param: StaticParameters<T, unknown[], []>) => (U & {
    params: unknown[];
})["static"])

Optionaltitle

title?: string

Title of this schema

type

type: "Function"

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties