feat: add optional withNumber parameter

README.md

@@ -18,11 +18,12 @@ import numd from 'numd';
 
 numd(2, 'dollar', 'dollars'); // 2 dollars
 numd(14, 'рубль', 'рубля', 'рублей'); // 14 рублей
+numd(14, 'метр', 'метра', 'метров', {withNumber: false}); // метров
 ```
 
 ## API
 
-### numd([num, ]word[, singular], plural)
+### numd([num, ]word[, singular], plural[, options])
 
 Return a string if `num` is defined:
 
@@ -37,6 +38,10 @@ otherwise return a function:
 const rur = numd('рубль', 'рубля', 'рублей');
 rur(4); // 4 рубля
 rur(51); // 51 рубль
+
+const meters = numd('метр', 'метра', 'метров', {withNumber: false});
+rur(4); // метра
+rur(55); // метров
 ```
 
 #### num
@@ -63,6 +68,25 @@ Type: `string`
 
 Word in the plural/genitive plural.
 
+#### options
+
+Type: `object`
+
+Options object. Care about passing the third parameter `plural` when passing the options:
+
+```js
+import numd from 'numd';
+
+numd(2, 'dollar', 'dollars', null, {withNumber: false}); // dollars
+numd(14, 'рубль', 'рубля', 'рублей', {withNumber: false}); // рублей
+```
+
+#### options.withNumber
+
+Type: `boolean`
+
+Flag indicating whether the number should be included in the result string
+
 ## License
 
 MIT

index.d.ts

@@ -1,3 +1,14 @@
-declare function numd(num: number, word: string, singular: string, plural?: string): string
-declare function numd(word: string, singular: string, plural?: string): (num: number) => string
-export default numd
+declare function numd(
+  num: number,
+  word: string,
+  singular: string,
+  plural?: string,
+  options?: { withNumber?: boolean }
+): string;
+declare function numd(
+  word: string,
+  singular: string,
+  plural?: string | null,
+  options?: { withNumber?: boolean }
+): (num: number) => string;
+export default numd;

index.js

@@ -4,17 +4,19 @@ const isGenitivePlural = num =>
 
 const isGenitiveSingular = num => Math.floor(num) !== num || num % 10 >= 2;
 
-const pluralize = (word, singular, plural) => num => {
+const pluralize = (word, singular, plural, options = {}) => num => {
+  const { withNumber = true } = options;
+  const displayNum = withNumber ? `${num} ` : '';
   const abs = Math.abs(num);
-  if (abs === 1) return `${num} ${word}`;
-  if (!plural) return `${num} ${singular}`;
-  if (isGenitivePlural(abs)) return `${num} ${plural}`;
-  if (isGenitiveSingular(abs)) return `${num} ${singular}`;
-  return `${num} ${word}`;
+  if (abs === 1) return `${displayNum}${word}`;
+  if (!plural) return `${displayNum}${singular}`;
+  if (isGenitivePlural(abs)) return `${displayNum}${plural}`;
+  if (isGenitiveSingular(abs)) return `${displayNum}${singular}`;
+  return `${displayNum}${word}`;
 };
 
-export default function numd(num, ...words) {
+export default function numd(num, ...params) {
   return typeof num === 'number' ?
-    pluralize(...words)(num) :
-    pluralize(num, ...words);
+    pluralize(...params)(num) :
+    pluralize(num, ...params);
 }