| title | PluralFunction |
|---|---|
| parent | @messageformat/core |
| grand_parent | API Reference |
Function used to define the pluralisation for a locale
Signature:
export interface PluralFunction (value: number | string, ord?: boolean) => PluralCateogry
May be used as a MessageFormat constructor locale argument.
| Property | Modifiers | Type | Description |
|---|---|---|---|
| cardinals? | Plurals.PluralCategory[] | (Optional) Which plurals may be returned if ord is falsy |
|
| module? | string | (Optional) The name of the module from which this function may be imported | |
| ordinals? | Plurals.PluralCategory[] | (Optional) Which plurals may be returned if ord is true |