@stdlib/string-substring-before v0.2.1

substringBefore

Return the part of a string before a specified substring.

Installation

npm install @stdlib/string-substring-before

Usage

var substringBefore = require( '@stdlib/string-substring-before' );

substringBefore( str, search )

Returns the part of a string before a specified substring.

var str = 'beep boop';
var out = substringBefore( str, ' ' );
// returns 'beep'

out = substringBefore( str, 'o' );
// returns 'beep b'

Notes

• If a substring is not present in a provided string, the function returns the input string.
• If provided an empty substring, the function returns an empty string.

Examples

var substringBefore = require( '@stdlib/string-substring-before' );

var out = substringBefore( 'beep boop', 'p' );
// returns 'bee'

out = substringBefore( 'Hello World!', 'xyz' );
// returns 'Hello World!'

out = substringBefore( 'Hello World!', '' );
// returns ''

out = substringBefore( '', 'xyz' );
// returns ''

See Also

• @stdlib/string-substring-before-cli: CLI package for use as a command-line utility.
• @stdlib/string-substring-before-last: return the part of a string before the last occurrence of a specified substring.
• @stdlib/string-substring-after: return the part of a string after a specified substring.
• @stdlib/string-substring-after-last: return the part of a string after the last occurrence of a specified substring.

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.