Replace search occurrences with a replacement string.
npm install @stdlib/string-replaceAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch. - To use as a general utility for the command line, install the corresponding CLI package globally.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var replace = require( '@stdlib/string-replace' );Replaces search occurrences with a replacement string.
var out = replace( 'beep', 'e', 'o' );
// returns 'boop'If provided a function as the third argument, the function is invoked for each match, and the function's return value is used as the replacement string.
function replacer( match, p1 ) {
return '/' + p1 + '/';
}
var str = 'Oranges and lemons';
var out = replace( str, /([^\s]+)/gi, replacer );
// returns '/Oranges/ /and/ /lemons/'-
The function has one notable difference from
String.prototype.replace. When provided a string as thesearchvalue, the function replaces all occurrences. To remove only the first match, use a regular expression.var out = replace( 'beep', /e/, 'o' ); // returns 'boep'
var capitalize = require( '@stdlib/string-capitalize' );
var replace = require( '@stdlib/string-replace' );
var out = replace( 'beep', 'e', 'o' );
// returns 'boop'
out = replace( 'Hello World', /world/i, 'Mr. President' );
// returns 'Hello Mr. President'
function replacer( match, p1 ) {
return capitalize( p1 );
}
var str = 'Oranges and lemons say the bells of St. Clement\'s';
out = replace( str, /([^\s]*)/gi, replacer );
// returns 'Oranges And Lemons Say The Bells Of St. Clement\'s'To use as a general utility, install the CLI package globally
npm install -g @stdlib/string-replace-cliUsage: replace [options] [<string>] --search=<string> --newval=<string>
Options:
-h, --help Print this message.
-V, --version Print the package version.
--search string Search string.
--newval string Replacement string.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
-
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'foo\nbar' | replace --search='o' --newval='e' --split /\r?\n/ # Escaped... $ echo -n $'foo\nbar' | replace --search='o' --newval='e' --split /\\r?\\n/
-
The implementation ignores trailing delimiters.
$ replace --search='/[eo]/' --newval=a beep
baapTo use as a standard stream,
$ echo -n 'boop' | replace --search='o' --newval='e'
beepBy default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.
$ echo -n 'boop\tfoo' | replace --search='o' --newval='e' --split '\t'
beep
feeThis package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
