Replace search occurrences with a replacement string.
npm install @stdlib/string-base-replaceWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Replace search occurrences with a replacement string.
``bash`
npm install @stdlib/string-base-replace
`javascript`
var replace = require( '@stdlib/string-base-replace' );
#### replace( str, search, newval )
Replaces search occurrences with a replacement string.
`javascript`
var out = replace( 'beep', /e/g, '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.
`javascript`
function replacer( match, p1 ) {
return '/' + p1 + '/';
}
var str = 'Oranges and lemons';
var out = replace( str, /([^\s]+)/gi, replacer );
// returns '/Oranges/ /and/ /lemons/'
- The function assumes that the search argument is a [regular expression][mdn-regexp]. Accordingly, the function should not be used as a general drop-in replacement for [String.prototype.replace][mdn-string-replace].
`javascript
var capitalize = require( '@stdlib/string-base-capitalize' );
var replace = require( '@stdlib/string-base-replace' );
var 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'
`
*
- [@stdlib/string-base/replace-after][@stdlib/string/base/replace-after]: replace the substring after the first occurrence of a specified search string.
- [@stdlib/string-base/replace-before][@stdlib/string/base/replace-before]: replace the substring before the first occurrence of a specified search string.
- [@stdlib/string-base/replace-after-last][@stdlib/string/base/replace-after-last]: replace the substring after the last occurrence of a specified search string.
- [@stdlib/string-base/replace-before-last][@stdlib/string/base/replace-before-last]: replace the substring before the last occurrence of a specified search string.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-base-replace.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-base-replace
[test-image]: https://github.com/stdlib-js/string-base-replace/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/string-base-replace/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-base-replace/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-base-replace?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/string-base-replace/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-base-replace/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-base-replace/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-base-replace/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-base-replace/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-base-replace/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-base-replace/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-base-replace/main/LICENSE
[mdn-string-replace]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
[@stdlib/string/base/replace-after]: https://www.npmjs.com/package/@stdlib/string-base-replace-after
[@stdlib/string/base/replace-before]: https://www.npmjs.com/package/@stdlib/string-base-replace-before
[@stdlib/string/base/replace-after-last]: https://www.npmjs.com/package/@stdlib/string-base-replace-after-last
[@stdlib/string/base/replace-before-last]: https://www.npmjs.com/package/@stdlib/string-base-replace-before-last