Interface ExtraOptions<TEntriesModel, TExtraModel>

Additional options for the map schema.

Type Parameters

  • in out TEntriesModel extends EntriesModel

    Per-entry model type.

  • out TExtraModel extends UcModel

    Extra entries model type, or false to prohibit extra entries.

Hierarchy

Properties

duplicates? extra where? within?

Properties

Optional Readonly duplicates

duplicates?: "reject" | "collect" | "overwrite"

How to handle duplicate entries of the map.

Can be one of:

  • 'collect' to collect duplicates into one value. It is a good idea to declared map entry schemas as lists or multi-values.
  • 'overwrite' (the default) to entry value each time it is received. The value specified the last takes precedence.
  • 'reject' to reject duplicate entries.

Readonly extra

extra: TExtraModel

Optional Readonly where

where?: UcConstraints<Infer<TEntriesModel, TExtraModel>, UcMap.Schema<TEntriesModel, TExtraModel>> | readonly UcConstraints<Infer<TEntriesModel, TExtraModel>, UcMap.Schema<TEntriesModel, TExtraModel>>[]

Additional schema constraints.

Optional Readonly within

within?: UcPresentations<Infer<TEntriesModel, TExtraModel>, UcMap.Schema<TEntriesModel, TExtraModel>> | readonly UcPresentations<Infer<TEntriesModel, TExtraModel>, UcMap.Schema<TEntriesModel, TExtraModel>>[]

Additional schema instance presentation constraints.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc