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

truncate

Truncate a string to a specified length.

Usage

var truncate = require( '@stdlib/string/truncate' );

truncate( str, len[, ending] )

Truncates a string to a specified length.

var out = truncate( 'beep boop', 7 );
// returns 'beep...'

By default, the truncated string is appended with '...'. To customize the truncated string, provide an ending argument:

var out = truncate( 'beep boop', 7, '!' );
// returns 'beep b!'

out = truncate( 'beep boop', 7, '!!!' );
// returns 'beep!!!'

Examples

var truncate = require( '@stdlib/string/truncate' );

var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
var out = truncate( str, 14 );
// returns 'Lorem ipsum...'

str = 'To be or not to be, that is the question';
out = truncate( str, 19, '!' );
// returns 'To be or not to be!'

str = 'The quick fox jumps over the lazy dog.';
out = truncate( str, 16, '...' );
// returns 'The quick fox...'

str = '🐺 Wolf Brothers 🐺';
out = truncate( str, 6 );
// returns '🐺 W...'

---

CLI

Usage

Usage: truncate [options] [<string>] --len <length>

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --len length          String length.
         --ending str          Custom ending. Default: '...'.
         --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 $'Hello, World!\nBeep Boop Baz' | truncate --len 6 --split /\r?\n/
  
  # Escaped...
  $ echo -n $'Hello, World!\nBeep Boop Baz' | truncate --len 6 --split /\\r?\\n/
  

• The implementation ignores trailing delimiters.

Examples

$ truncate 'Hello, World!' --len 8
Hello...

$ truncate 'Hello, World!' --len 6 --ending '!'
Hello!

To use as a standard stream,

$ echo -n 'Hello, World!' | truncate --len 8
Hello...

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 'Hello, World!\tBeep Boop' | truncate --split '\t' --len 8
Hello...
Beep ...

---

See Also

• @stdlib/string/truncate-middle: truncate a string in the middle to a specified length.