Link Search Menu Expand Document

PluralFunction interface

Function used to define the pluralisation for a locale

Signature:

export interface PluralFunction 

Remarks

(value: number | string, ord?: boolean) => PluralCateogry

May be used as a MessageFormat constructor locale argument.

Properties

Property Type Description
cardinals Plurals.PluralCategory[] Which plurals may be returned if ord is falsy
module string The name of the module from which this function may be imported
ordinals Plurals.PluralCategory[] Which plurals may be returned if ord is true