Interface Options<TItem, TItemModel>

Additional options for the list schema.

Type Parameters

  • TItem = unknown

    Type of list item.

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

    Type of list item model.

Hierarchy

Properties

single? where? within?

Properties

Optional Readonly single

single?: "accept" | "reject"

How to treat single values.

One of:

'accept' to treat single value as list with single item. 'reject' (the default) to reject single value.

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

Optional Readonly where

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

Additional schema constraints.

Optional Readonly within

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

Additional schema instance presentation constraints.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc