@stdlib/string-replace

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

replace

Replace search occurrences with a replacement string.

Installation

npm install @stdlib/string-replace

Usage

var replace = require( '@stdlib/string-replace' );

replace( str, search, newval )

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/'

Notes

• The function has one notable difference from String.prototype.replace. When provided a string as the search value, the function replaces all occurrences. To remove only the first match, use a regular expression.

  var out = replace( 'beep', /e/, 'o' );
  // returns 'boep'
  

Examples

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'

See Also

• @stdlib/string-replace-cli: CLI package for use as a command-line utility.

---

Notice

This 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.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.0 (2024-02-14)

<section class="bug-fixes">

Bug Fixes

• ff35f38 - make CLI scripts executable (#1111)

</section> <!-- /.bug-fixes --> <section class="commits">

Commits

<details>

• dea49e0 - docs: use single quotes in require calls instead of backticks (by Philipp Burckhardt)
• f9c75ce - build: remove tslint directives (by Philipp Burckhardt)
• ff35f38 - fix: make CLI scripts executable (#1111) (by stdlib-bot, Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.1.1">