Function pluralize

  • pluralize(word, count?, inclusive?): string

  • Pluralize or singularize a word based on the passed in count.

    Parameters

    • word: string
    • Optionalcount: number
    • Optionalinclusive: boolean

    Returns string

Methods

addIrregularRule addPluralRule addSingularRule addUncountableRule isPlural isSingular plural singular

Methods

addIrregularRule

  • addIrregularRule(single, plural): void

  • Add an irregular word definition.

    Parameters

    • single: string
    • plural: string

    Returns void

addPluralRule

  • addPluralRule(rule, replacement): void

  • Add a pluralization rule to the collection.

    Parameters

    • rule: string | RegExp
    • replacement: string

    Returns void

addSingularRule

  • addSingularRule(rule, replacement): void

  • Add a singularization rule to the collection.

    Parameters

    • rule: string | RegExp
    • replacement: string

    Returns void

addUncountableRule

  • addUncountableRule(word): void

  • Add an uncountable word rule.

    Parameters

    • word: string | RegExp

    Returns void

isPlural

  • isPlural(word): boolean

  • Test if provided word is plural.

    Parameters

    • word: string

    Returns boolean

isSingular

  • isSingular(word): boolean

  • Test if provided word is singular.

    Parameters

    • word: string

    Returns boolean

plural

  • plural(word): string

  • Pluralize a word based.

    Parameters

    • word: string

    Returns string

singular

  • singular(word): string

  • Singularize a word based.

    Parameters

    • word: string

    Returns string

Settings

Member Visibility

On This Page

Methods