Package Exports
- @stdlib/string-truncate
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-truncate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
truncate
Truncate a string to a specified length.
Installation
npm install @stdlib/string-truncateUsage
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
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/string-truncateUsage
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
splitoption 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 ...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-2021. The Stdlib Authors.