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!

replaceBefore

Replace the substring before the first occurrence of a specified search string.

Installation

npm install @stdlib/string-base-replace-before

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

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

replaceBefore( str, search, replacement, fromIndex )

Replaces the substring before the first occurrence of a specified search string.

var out = replaceBefore( 'beep boop', ' ', 'loop', 0 );
// returns 'loop boop'

out = replaceBefore( 'beep boop', 'o', 'bar', 0 );
// returns 'baroop'

To begin searching from a specific index, provide a corresponding fromIndex argument.

var out = replaceBefore( 'beep boop', 'p', 'bar', 5 );
// returns 'barp'

If fromIndex is less than zero, the starting index is resolved relative to the last string character, with the last string character corresponding to fromIndex = -1.

var out = replaceBefore( 'beep boop beep', ' ', 'loop', -6 );
// returns 'loop beep'

Notes

• If a search string is not present in a provided string, the function returns the provided string unchanged.
• If a search string is an empty string, the function returns the provided string unchanged.
• If fromIndex resolves to an index which is greater than or equal to str.length, the function returns the provided string unchanged.

Examples

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

var out = replaceBefore( 'beep boop', 'p', 'see', 0 );
// returns 'seep boop'

out = replaceBefore( 'Hello World!', 'xyz', 'foo', 0 );
// returns 'Hello World!'

out = replaceBefore( 'Hello World!', '', 'foo', 0 );
// returns 'Hello World!'

out = replaceBefore( '', 'xyz', 'foo', 0 );
// returns ''

---

See Also

• @stdlib/string-base/replace-after: replace the substring after the first occurrence of a specified search string.
• @stdlib/string-base/replace-before-last: replace the substring before the last occurrence of a specified search string.
• @stdlib/string-base/replace-after-last: replace the substring after the last occurrence of a specified search string.

---

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.