Interface Options<TItem, TItemModel>

Additional options for the multi-value schema.

Type Parameters

TItem = unknown

Type of single item.
TItemModel extends UcModel<TItem> = UcModel<TItem>

Type of single item model.

Hierarchy

Extension<TItem | TItem[], UcMultiValue.Schema<TItem, TItemModel>>
UcMultiValue.Variant
- Options

Index

Properties

single? where? within?

Properties

`Optional` `Readonly` single

single?: "as-is" | "prefer"

How to treat single values.

One of:

'as-is' (the default) to treat a single value as is and not convert it to array. 'prefer' to treat an array with single item as single value.

This option is ignored if single item type is a list itself.

`Optional` `Readonly` where

where?: UcConstraints<TItem | TItem[], UcMultiValue.Schema<TItem, TItemModel>> | readonly UcConstraints<TItem | TItem[], UcMultiValue.Schema<TItem, TItemModel>>[]

Additional schema constraints.

`Optional` `Readonly` within

within?: UcPresentations<TItem | TItem[], UcMultiValue.Schema<TItem, TItemModel>> | readonly UcPresentations<TItem | TItem[], UcMultiValue.Schema<TItem, TItemModel>>[]

Additional schema instance presentation constraints.

Generated using TypeDoc