time-to-botec/squiggle/node_modules/@stdlib/string/substring-after/README.md

substringAfter

Return the part of a string after a specified substring.

Usage

var substringAfter = require( '@stdlib/string/substring-after' );

substringAfter( str, search[, fromIndex] )

Returns the part of a string after a specified substring.

var str = 'beep boop';
var out = substringAfter( str, 'o' );
// returns 'op'

out = substringAfter( str, ' ' );
// returns 'boop'

By default, the search starts at the beginning of the string. To start searching from a different index, provide a fromIndex argument:

var str = 'boop baz boop';
var out = substringAfter( str, 'o', 3 );
// returns 'op'

Notes

• If a substring is not present in a provided string, the function returns an empty string.
• If provided an empty substring, the function returns the input string.
• If fromIndex is less than 0 or greater than str.length, the search starts at index 0 and str.length, respectively.

Examples

var substringAfter = require( '@stdlib/string/substring-after' );

var str = 'To be, or not to be, that is the question.';
var out = substringAfter( str, ', ' );
// returns 'or not to be, that is the question.'

out = substringAfter( str, 'to be' );
// returns ', that is the question.'

out = substringAfter( str, 'question.' );
// returns ''

out = substringAfter( str, 'xyz' );
// returns ''

out = substringAfter( str, '' );
// returns 'To be, or not to be, that is the question.'

---

CLI

Usage

Usage: substring-after [options] --search=<string> [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --search string       Search string.
         --from-index int      Start index. Default: 0.
         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

Notes

• If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

  # Not escaped...
  $ echo -n $'foo\nbar\nbaz' | substring-after --search a --split /\r?\n/
  
  # Escaped...
  $ echo -n $'foo\nbar\nbaz' | substring-after --search a --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ substring-after abcdefg --search d
efg

To use as a standard stream,

$ echo -n $'bar\nbaz' | substring-after --search b
ar
az

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

$ echo -n 'bar\tbaz' | substring-after --search b --split '\t'
ar
az

---

See Also

• @stdlib/string/substring-before: return the part of a string before a specified substring.
• @stdlib/string/substring-before-last: return the part of a string before the last occurrence of a specified substring.
• @stdlib/string/substring-after-last: return the part of a string after the last occurrence of a specified substring.