@stdlib/string-truncate NPM

truncate

Truncate a string to a specified length.

Installation

npm install @stdlib/string-truncate

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

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.