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

[![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.

## Installation

bash
npm install @stdlib/string-replace

Alternatively,

- To load the package in a website via a script tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [deno][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [umd][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

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

#### replace( str, search, newval )

Replaces search occurrences with a replacement string.

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

If provided a function as the [third argument][mdn-string-replace], 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/'

## Notes

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

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

## Examples

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

## CLI

## Installation

To use as a general utility, install the CLI package globally

bash
npm install -g @stdlib/string-replace-cli

### Usage

text
Usage: 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/'.

### Notes

- If the split separator is a [regular expression][mdn-regexp], ensure that the split option is either properly escaped or enclosed in quotes.

bash
    # 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.

### Examples

bash
$ replace --search='/[eo]/' --newval=a beep
baap

To use as a [standard stream][standard-streams],

bash
$ echo -n 'boop' | replace --search='o' --newval='e'
beep

By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.

bash
$ echo -n 'boop\tfoo' | replace --search='o' --newval='e' --split '\t'
beep
fee

*

## Notice

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]

—-

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].