Interface Schema<TItem, TItemModel>

Schema definition for multi-value serialized as list or single value.

Such schema can be built with ucMultiValue function.

Type Parameters

  • out TItem = unknown

    Type of single item.

  • out TItemModel extends UcModel<TItem> = UcModel<TItem>

    Type of single item model.

Hierarchy

Properties

item nullable? optional? type where? within?

Methods

__UcSchema__? toString?

Properties

Readonly item

item: Of<TItemModel>

Single item schema.

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: "list"

Either unique type name, or type class.

Code generation is based on this name.

Optional Readonly where

where?: UcConstraints<TItem | TItem[], UcSchema<TItem | TItem[]>>

Schema constraints.

Optional Readonly within

within?: UcPresentations<TItem | TItem[]>

Schema instance presentation constraints.

Methods

Optional __UcSchema__

Optional toString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc