Replace all substring matches in a string
JavaScript
Latest commit 236a877 Jan 11, 2017 @sindresorhus 1.1.0
Permalink
Failed to load latest commit information.
.editorconfig Init Jan 5, 2017
.gitattributes Init Jan 5, 2017
.gitignore Init Jan 5, 2017
.travis.yml Init Jan 5, 2017
index.js Cleanup and improve #3 Jan 11, 2017
license Init Jan 5, 2017
package.json 1.1.0 Jan 11, 2017
readme.md Cleanup and improve #3 Jan 11, 2017
test.js Add `fromIndex` option (#3) Jan 11, 2017

readme.md

replace-string Build Status

Replace all substring matches in a string

Similar to String#replace(), but supports replacing multiple matches. You could achieve something similar by putting the string in a RegExp constructor with the global flag and passing it to String#replace(), but you would then have to first escape the string anyways.

Install

$ npm install --save replace-string

Usage

const replaceString = require('replace-string');

const input = 'My friend has a πŸ‘. I want a πŸ‘ too!';

replaceString(input, 'πŸ‘', 'πŸ¦„');
//=> 'My friend has a πŸ¦„. I want a πŸ¦„ too!'

API

replaceString(input, needle, replacement, [options])

Returns a new string with all needle matches replaced with replacement.

input

Type: string

String to work on.

needle

Type: string

String to match in input.

replacement

Type: string Function

Replacement for needle matches.

If a function, it receives the following arguments; the needle, the match count, and the input:

replaceString('Foo πŸ‘ Bar', 'πŸ‘', (needle, matchCount, input) => `${needle}❀️`);
//=> 'Foo πŸ‘β€οΈ Bar'

options

Type: Object

fromIndex

Type: number
Default: 0

Index at which to start replacing.

Related

  • execall - Find multiple RegExp matches in a string

License

MIT Β© Sindre Sorhus