decline-of-numeral

simple function for decline word

Table of Contents

• Quick start
  • Install
  • Initialization
• Methods
  • declineOfNumeral

Quick start

Install

We support all platforms.

npm

For module bundlers such as Webpack or Browserify.

npm i decline-of-numeral

Include with <script>

1. Download lib
2. Add script to html

<script src="decline-of-numeral.js"></script>

CDN

Recommended for learning purposes, you can use the latest version:

<script src="https://cdn.jsdelivr.net/npm/decline-of-numeral/dist/lib/decline-of-numeral.js"></script>

Recommended for production for avoiding unexpected breakage from newer versions:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lib/decline-of-numeral.js"></script>

Initialization

ES6

decline-of-numeral as an ES6 module.

import declineOfNumeral from 'decline-of-numeral';

declineOfNumeral(1, ['минута', 'минуты', 'минут'])

Node

decline-of-numeral as a Node.js module

const declineOfNumeral = require('decline-of-numeral');

declineOfNumeral(1, ['минута', 'минуты', 'минут'])

Browser

Exports a global variable called declineOfNumeral. Use it like this

Connect to html file <script src="https://cdn.jsdelivr.net/npm/decline-of-numeral/dist/lib/decline-of-numeral.js" ></script>

<script>
    declineOfNumeral(1, ['минута', 'минуты', 'минут'])
</script>

AMD

decline-of-numeral as an AMD module. Use with Require.js, System.js, and so on.

1. Download lib
2. Connect to your module loader

requirejs(['decline-of-numeral'], function(decliner) {
    declineOfNumeral(1, ['минута', 'минуты', 'минут'])
});

Methods

declineOfNumeral

function decline numeral word

Params

• quantity
  • Type: number,string
  • Description: count of numeral
• arrayOfDeclinedWords
  • Type: Array.<string>
  • Description: all variants of the declension of the word

Returns

• string

Example

//ru
declineOfNumeral(1, ['минута', 'минуты', 'минут']) // => 'минута'
declineOfNumeral(2, ['минута', 'минуты', 'минут']) // => 'минуты'
declineOfNumeral(5, ['минута', 'минуты', 'минут']) // => 'минут'

//en
declineOfNumeral(1, ['cat', 'cats']) // => 'cat'
declineOfNumeral(2, ['cat', 'cats']) // => 'cats'
declineOfNumeral(5, ['cat', 'cats']) // => 'cats'

Author

webster6667