Interface TTransform<I, O>

interface TTransform<I, O> {
    $id?: string;
    $schema?: string;
    [Hint]?: string;
    [Kind]: string;
    [OptionalKind]?: string;
    [ReadonlyKind]?: string;
    [TransformKind]: TransformOptions<I, O>;
    default?: any;
    description?: string;
    examples?: any;
    params: unknown[];
    readOnly?: boolean;
    static: TransformStatic<I, unknown[]>;
    title?: string;
    writeOnly?: boolean;
    [key: string]: any;
}

Type Parameters

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

$id?: string

Id for this schema

$schema?: string
[Hint]?: string
[Kind]: string
[OptionalKind]?: string
[ReadonlyKind]?: string
[TransformKind]: TransformOptions<I, O>
default?: any

Default value for this schema

description?: string

Description of this schema

examples?: any

Example values matching this schema

params: unknown[]
readOnly?: boolean

Optional annotation for readOnly

static: TransformStatic<I, unknown[]>
title?: string

Title of this schema

writeOnly?: boolean

Optional annotation for writeOnly