Interface UcSchema<T>

Data schema definition.

Describes data type along with its serialization format.

Type Parameters

  • out T = unknown

    Implied data type.

Hierarchy

Properties

nullable? optional? type where? within?

Methods

__UcSchema__? toString?

Properties

Optional Readonly nullable

nullable?: boolean

Whether the data is nullable.

When true the data value may be null.

Default Value

false, which means null data value prohibited.

Optional Readonly optional

optional?: boolean

Whether the data is optional.

When true the data value may be undefined.

Default Value

false, which means undefined data value prohibited.

Readonly type

type: string | UcDataType<T>

Either unique type name, or type class.

Code generation is based on this name.

Optional Readonly where

where?: UcConstraints<T, UcSchema<T>>

Schema constraints.

Optional Readonly within

within?: UcPresentations<T>

Schema instance presentation constraints.

Methods

Optional __UcSchema__

Optional toString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc