time-to-botec/squiggle/node_modules/@stdlib/string/remove-first

removeFirst

Remove the first character(s) of a string.

Usage

var removeFirst = require( '@stdlib/string/remove-first' );

removeFirst( str[, n] )

Removes the first character of a string.

var out = removeFirst( 'last man standing' );
// returns 'ast man standing'

out = removeFirst( 'Hidden Treasures' );
// returns 'idden Treasures'

If provided a second argument, the function removes the first n characters.

var out = removeFirst( 'foo bar', 4 );
// returns 'bar'

out = removeFirst( 'foo bar', 10 );
// returns ''

Examples

var removeFirst = require( '@stdlib/string/remove-first' );

var str = removeFirst( 'last man standing' );
// returns 'ast man standing'

str = removeFirst( 'presidential election' );
// returns 'residential election'

str = removeFirst( 'javaScript' );
// returns 'avaScript'

str = removeFirst( 'Hidden Treasures' );
// returns 'idden Treasures'

str = removeFirst( 'The Last of the Mohicans', 4 );
// returns 'Last of the Mohicans'

str = removeFirst( '🐶🐮🐷🐰🐸', 2 );
// returns '🐷🐰🐸'

str = removeFirst( '🐶🐮🐷🐰🐸', 10 );
// returns ''

---

CLI

Usage

Usage: remove-first [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --n                   Number of characters to remove. Default: 1.
         --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 $'beep\nboop' | remove-first --split /\r?\n/
  
  # Escaped...
  $ echo -n $'beep\nboop' | remove-first --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ remove-first beep
eep

To use as a standard stream,

$ echo -n 'beep\nboop' | remove-first --n=2
be
bo

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 'beep\tboop' | remove-first --split '\t'
eep
oop

---

See Also

• @stdlib/string/remove-last: remove the last character of a string.