@stdlib/string-truncate
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

truncate

NPM version Build Status Coverage Status

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

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/string-truncate

Homepage

stdlib.io

Weekly Downloads

172

Version

0.2.1

License

Apache-2.0

Unpacked Size

31.6 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser