Nightclub Party Music

    @stdlib/string-substring-after
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.2 • Public • Published

    substringAfter

    NPM version Build Status Coverage Status

    Return the part of a string after a specified substring.

    Installation

    npm install @stdlib/string-substring-after

    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

    Installation

    To use the module as a general utility, install the module globally

    npm install -g @stdlib/string-substring-after

    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


    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/string-substring-after

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    30

    Version

    0.0.2

    License

    Apache-2.0

    Unpacked Size

    33.8 kB

    Total Files

    12

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser