Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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: '...'.

Examples

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

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

See Also