Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.81 KB

readme.md

File metadata and controls

53 lines (33 loc) · 1.81 KB

replace-once

npm package version Travis build status npm package downloads code style license

Make multiple replacements in a string without replacing ones that have already been replaced.

Installation

npm install --save replace-once

Usage

replaceOnce(str, find, replace, [ flags ])

const replaceOnce = require('replace-once')

var str = 'abc abcd a ab'
var find = ['abcd', 'abc', 'ab', 'a']
var replace = ['a', 'ab', 'abc', 'abcd']
replaceOnce(str, find, replace, 'gi')
//=> 'ab a abcd abc'

Parameters

str (string)

The string to do replacements on.

find (array)

An array of strings to search for when doing replacements. Must be in the same order as their replacement specified inside of the replace parameter. Strings may contain Regular Expressions (regexp).

replace (array)

An array of strings to replace the strings specified inside of the find parameter with. Must be in the same order as their counterpart specified inside of the find parameter.

flags (string)

Optional

RegExp flags to use when doing replacements. (e.g g for global, i for case-insensitive)

License

MIT. See the license.md file for more info.