replace-nth

replace-nth

Replace only specific occurrences of a string. e.g. if the string exists 10 times, you can replace, say, the 3rd and 8th occurrences only, etc. Returns a new string with nth specific matches of a pattern replaced by a replacement. The pattern can be a string or a RegExp, and the replacement can be a string or a function to be called for each match.

Install

Install with npm:

npm i replace-nth --save-dev

Usage

var replaceNth = require('replace-nth');
replaceNth( params );

Params:

• num (string): a number formatted as a string.
• pattern (regex|string): The actual pattern to find and replace nth times
• replacement (string): the replacement to use
• str (string): the string to search for replacements

Example:

var params = {
  // pass any string
  str: 'aaaaaaaaaaaaaaa'
  // The nth number of match(es) to replace
  num: '[135]',
  // The pattern to replace
  pattern: /a/g,
  // the replacement to use
  replacement: 'B',
};
console.log(replaceNth(params));
//=> 'BaBaBaaaaaaaaaa'

num

• '12' returns twelvth match,
• '[124]' returns the first, second and fourth matchs, and so on.

See the tests for more examples.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

This file was generated by verb-cli on June 14, 2014.