time-to-botec/squiggle/node_modules/@stdlib/string/right-trim-n/README.md

rtrimN

Trim n characters from the end of a string.

Usage

var rtrimN = require( '@stdlib/string/right-trim-n' );

rtrimN( str, n[, chars] )

Trims n characters from the end of a string.

var str = '  foo  ';
var out = rtrimN( str, str.length );
// returns '  foo'

out = rtrimN( str, 1 );
// returns '  foo '

By default, the function trims whitespace characters. To trim a different set of characters instead, provide a string or an array of characters to trim:

var str = '🐶🐶🐶 Animals 🐶🐶🐶';
var out = rtrimN( str, str.length, [ '🐶', ' ' ] );
// returns '🐶🐶🐶 Animals'

out = rtrimN( str, str.length, '🐶 ' );
// returns '🐶🐶🐶 Animals'

Examples

var rtrimN = require( '@stdlib/string/right-trim-n' );

var out = rtrimN( '   Whitespace   ', 3 );
// returns '   Whitespace'

out = rtrimN( '\t\t\tTabs\t\t\t', 2 );
// returns '\t\t\tTabs\t'

out = rtrimN( '~~~CUSTOM~~~', 3, '~' );
// returns '~~~CUSTOM'

---

CLI

Usage

Usage: rtrimn [options] --n=<number>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --n number            Number of characters to trim.
         --chars str           Characters to trim. Default: whitespace.
         --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   \n   bar   ' | rtrimn --n=3 --split /\r?\n/
  
  # Escaped...
  $ echo -n $'   foo   \n   bar   ' | rtrimn --n=3 --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ rtrimn '   Whitespace   ' --n=3
   Whitespace

To use as a standard stream,

$ echo -n '~beep~boop~~~' | rtrimn --n=2 --chars '~'
~beep~boop~

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 '~~~foo~~~\t~~~bar~~~\t~~~baz~~~' | rtrimn --split '\t' --chars '~' --n=3
~~~foo
~~~bar
~~~baz