@stdlib/string-right-trim

Right Trim

Trim whitespace characters from the end of a string.

Installation

npm install @stdlib/string-right-trim

Usage

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

rtrim( str )

Trims whitespace from the end of a string.

var out = rtrim( ' \t\t\n  Beep \r\n\t  ' );
// returns ' \t\t\n  Beep'

Notes

• Following Unicode 6.3.0 and later, "whitespace" is defined as the following characters: [ \\f\\n\\r\\t\\v\\u0020\\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff].

Examples

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

var out = rtrim( '   Whitespace   ' );
// returns '   Whitespace'

out = rtrim( '\t\t\tTabs\t\t\t' );
// returns '\t\t\tTabs'

out = rtrim( '\n\n\nNew Lines\n\n\n' );
// returns '\n\n\nNew Lines'

CLI

Installation

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

npm install -g @stdlib/string-right-trim

Usage

Usage: rtrim [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --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   ' | rtrim --split /\r?\n/
  
  # Escaped...
  $ echo -n $'   foo   \n   bar   ' | rtrim --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ rtrim 'beep boop  '
beep boop

To use as a standard stream,

$ echo -n 'beep boop  ' | rtrim
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   ' | rtrim --split '\t'
   foo
   bar
   baz

See Also

• @stdlib/string/left-trim: trim whitespace characters from the beginning of a string.
• @stdlib/string/trim: trim whitespace characters from the beginning and end of a string.

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

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.