Interface LabelCompositionParams<T>

Parameters for composing a label from an array of items.

interface LabelCompositionParams<T> {
    conjunctionWord?: ListConjunction | "And" | "AsWellAs" | "AlongWith";
    items: T[];
    labelKey: keyof T;
    multipleItemsPrefix?: MultipleItemsLabelPrefix | "IncludedIn" | "FoundWithin" | "PresentIn";
    singleItemPrefix?: "Only" | SingleItemLabelPrefix | "Exclusive" | "Solely";
}

Type Parameters

  • T

    The type of each item in the array.

Properties

conjunctionWord? items labelKey multipleItemsPrefix? singleItemPrefix?

Properties

Optional conjunctionWord

conjunctionWord?: ListConjunction | "And" | "AsWellAs" | "AlongWith"

Conjunction to use when listing items, applied before the last item. Defaults to ListConjunction.And.

items

items: T[]

Array of items to compose into the label.

labelKey

labelKey: keyof T

Key in each item to be used for label generation.

Optional multipleItemsPrefix

multipleItemsPrefix?: MultipleItemsLabelPrefix | "IncludedIn" | "FoundWithin" | "PresentIn"

Prefix to use for multiple items. Defaults to MultipleItemsLabelPrefix.FoundWithin.

Optional singleItemPrefix

singleItemPrefix?: "Only" | SingleItemLabelPrefix | "Exclusive" | "Solely"

Prefix to use if there is only one item. Defaults to SingleItemLabelPrefix.Only.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc