Logo for jsDocs.io

@types/pluralize

  • Version 0.0.33
  • Published
  • 5.77 kB
  • No dependencies
  • MIT license

Install

npm i @types/pluralize
yarn add @types/pluralize
pnpm add @types/pluralize

Overview

TypeScript definitions for pluralize

Index

Functions

Functions

function addIrregularRule

addIrregularRule: (single: string, plural: string) => void;

  • Add an irregular word definition.

    Parameter single

    Parameter plural

function addPluralRule

addPluralRule: (rule: string | RegExp, replacement: string) => void;

  • Add a pluralization rule to the collection.

    Parameter rule

    Parameter replacement

function addSingularRule

addSingularRule: (rule: string | RegExp, replacement: string) => void;

  • Add a singularization rule to the collection.

    Parameter rule

    Parameter replacement

function addUncountableRule

addUncountableRule: (word: string | RegExp) => void;

  • Add an uncountable word rule.

    Parameter word

function isPlural

isPlural: (word: string) => boolean;

  • Test if provided word is plural.

    Parameter word

function isSingular

isSingular: (word: string) => boolean;

  • Test if provided word is singular.

    Parameter word

function plural

plural: (word: string) => string;

  • Pluralize a word based.

    Parameter word

function pluralize

pluralize: typeof pluralize;

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

    Parameter word

    Parameter count

    Parameter inclusive

function singular

singular: (word: string) => string;

  • Singularize a word based.

    Parameter word

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/pluralize.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/pluralize)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/pluralize"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>