@stdlib/string-base-replace

What is @stdlib/string-base-replace?

@stdlib/string-base-replace is a utility package for performing string replacement operations. It provides a simple and efficient way to replace parts of a string based on a search pattern and a replacement string.

What are @stdlib/string-base-replace's main functionalities?

Basic String Replacement

This feature allows you to replace a substring within a string with another substring. In this example, 'world' is replaced with 'stdlib'.

const replace = require('@stdlib/string-base-replace');
const str = 'Hello, world!';
const result = replace(str, 'world', 'stdlib');
console.log(result); // 'Hello, stdlib!'

Regular Expression Replacement

This feature allows you to use regular expressions to find and replace patterns within a string. In this example, all occurrences of 'foo' are replaced with 'baz'.

const replace = require('@stdlib/string-base-replace');
const str = 'foo bar foo';
const result = replace(str, /foo/g, 'baz');
console.log(result); // 'baz bar baz'

Function as Replacement

This feature allows you to use a function to determine the replacement string. The function receives the matched substring and can return a modified version of it. In this example, 'foo' is replaced with its uppercase version.

const replace = require('@stdlib/string-base-replace');
const str = 'foo bar foo';
const result = replace(str, /foo/g, (match) => match.toUpperCase());
console.log(result); // 'FOO bar FOO'

Other packages similar to @stdlib/string-base-replace

replace-string

The replace-string package is a lightweight utility for replacing substrings within a string. It offers a simple API for basic string replacement operations but does not support regular expressions or function-based replacements like @stdlib/string-base-replace.

string-replace-to-array

The string-replace-to-array package allows for more complex replacement operations by returning an array of strings and replacement results. It provides more flexibility in handling replacements but may be overkill for simple use cases compared to @stdlib/string-base-replace.

README

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-base-replace

Usage

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

replace( str, search, newval )

Replaces search occurrences with a replacement string.

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.

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 assumes that the search argument is a regular expression. Accordingly, the function should not be used as a general drop-in replacement for String.prototype.replace.

Examples

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'

---

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.2 (2024-07-26)

<section class="commits">

Commits

<details>

• 659f752 - style: add missing spaces (by 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.2.1">