Package Exports
- @stdlib/string-substring-before
- @stdlib/string-substring-before/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-substring-before) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
substringBefore
Return the part of a string before a specified substring.
Installation
npm install @stdlib/string-substring-beforeUsage
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 ''CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-substring-beforeUsage
Usage: substring-before [options] --search=<string> [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--search string Search string.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.Notes
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'foo\nbar\nbaz' | substring-before --search a --split /\r?\n/ # Escaped... $ echo -n $'foo\nbar\nbaz' | substring-before --search a --split /\\r?\\n/
The implementation ignores trailing delimiters.
Examples
$ substring-before abcdefg --search d
abcTo use as a standard stream,
$ echo -n $'beep\nboop' | substring-before --search p
bee
booBy default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.
$ echo -n 'beep\tboop' | substring-before --search p --split '\t'
bee
booNotice
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-2022. The Stdlib Authors.