1. module pluralize
   1. function pluralize (word, count, inclusive)
   2. function pluralize.addIrregularRule (single, plural)
   3. function pluralize.addPluralRule (rule, replacement)
   4. function pluralize.addSingularRule (rule, replacement)
   5. function pluralize.addUncountableRule (word)
   6. function pluralize.plural (word)
   7. function pluralize.singular (word)

module pluralize

function pluralize (word, count, inclusive)

• description and source-code

  function pluralize(word, count, inclusive) {
    var pluralized = count === 1
      ? pluralize.singular(word) : pluralize.plural(word);
  
    return (inclusive ? count + ' ' : '') + pluralized;
  }

• example usage

  n/a

function pluralize.addIrregularRule (single, plural)

• description and source-code

  addIrregularRule = function (single, plural) {
    plural = plural.toLowerCase();
    single = single.toLowerCase();
  
    irregularSingles[single] = plural;
    irregularPlurals[plural] = single;
  }

• example usage

  ...
    ['valve', 'valves'],
    ['looey', 'looies'],
    ['thief', 'thieves'],
    ['groove', 'grooves'],
    ['pickaxe', 'pickaxes'],
    ['whiskey', 'whiskies']
  ].forEach(function (rule) {
    return pluralize.addIrregularRule(rule[0], rule[1]);
  });
  
  /**
   * Pluralization rules.
   */
  [
    [/s?$/i, 's'],
  ...

function pluralize.addPluralRule (rule, replacement)

• description and source-code

  addPluralRule = function (rule, replacement) {
    pluralRules.push([sanitizeRule(rule), replacement]);
  }

• example usage

  ...
  pluralize.addUncountableRule = function (word) {
    if (typeof word === 'string') {
      uncountables[word.toLowerCase()] = true;
      return;
    }
  
    // Set singular and plural references for the word.
    pluralize.addPluralRule(word, '$0');
    pluralize.addSingularRule(word, '$0');
  };
  
  /**
   * Add an irregular word definition.
   *
   * @param {string} single
  ...

function pluralize.addSingularRule (rule, replacement)

• description and source-code

  addSingularRule = function (rule, replacement) {
    singularRules.push([sanitizeRule(rule), replacement]);
  }

• example usage

  ...
    if (typeof word === 'string') {
      uncountables[word.toLowerCase()] = true;
      return;
    }
  
    // Set singular and plural references for the word.
    pluralize.addPluralRule(word, '$0');
    pluralize.addSingularRule(word, '$0');
  };
  
  /**
   * Add an irregular word definition.
   *
   * @param {string} single
   * @param {string} plural
  ...

function pluralize.addUncountableRule (word)

• description and source-code

  addUncountableRule = function (word) {
    if (typeof word === 'string') {
      uncountables[word.toLowerCase()] = true;
      return;
    }
  
    // Set singular and plural references for the word.
    pluralize.addPluralRule(word, '$0');
    pluralize.addSingularRule(word, '$0');
  }

• example usage

  ...
  pluralize.singular('singles') //=> "singular"
  
  pluralize.plural('irregular') //=> "irregulars"
  pluralize.addIrregularRule('irregular', 'regular')
  pluralize.plural('irregular') //=> "regular"
  
  pluralize.plural('paper') //=> "papers"
  pluralize.addUncountableRule('paper')
  pluralize.plural('paper') //=> "paper"
  ```
  
  ## License
  
  MIT
  ...

function pluralize.plural (word)

• description and source-code

  plural = function (word) {
    // Get the correct token and case restoration functions.
    var token = word.toLowerCase();
  
    // Check against the keep object map.
    if (keepMap.hasOwnProperty(token)) {
      return restoreCase(word, token);
    }
  
    // Check against the replacement map for a direct word replacement.
    if (replaceMap.hasOwnProperty(token)) {
      return restoreCase(word, replaceMap[token]);
    }
  
    // Run all the rules against the word.
    return sanitizeWord(token, word, rules);
  }

• example usage

  ...
   * @param  {string}  word
   * @param  {number}  count
   * @param  {boolean} inclusive
   * @return {string}
   */
  function pluralize (word, count, inclusive) {
    var pluralized = count === 1
      ? pluralize.singular(word) : pluralize.plural(word);
  
    return (inclusive ? count + ' ' : '') + pluralized;
  }
  
  /**
   * Pluralize a word.
   *
  ...

function pluralize.singular (word)

• description and source-code

  singular = function (word) {
    // Get the correct token and case restoration functions.
    var token = word.toLowerCase();
  
    // Check against the keep object map.
    if (keepMap.hasOwnProperty(token)) {
      return restoreCase(word, token);
    }
  
    // Check against the replacement map for a direct word replacement.
    if (replaceMap.hasOwnProperty(token)) {
      return restoreCase(word, replaceMap[token]);
    }
  
    // Run all the rules against the word.
    return sanitizeWord(token, word, rules);
  }

• example usage

  ...
   * @param  {string}  word
   * @param  {number}  count
   * @param  {boolean} inclusive
   * @return {string}
   */
  function pluralize (word, count, inclusive) {
    var pluralized = count === 1
      ? pluralize.singular(word) : pluralize.plural(word);
  
    return (inclusive ? count + ' ' : '') + pluralized;
  }
  
  /**
   * Pluralize a word.
   *
  ...