Truncate a string to a specified length.
npm install @stdlib/string-truncateWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Truncate a string to a specified length.
``bash`
npm install @stdlib/string-truncate
`javascript`
var truncate = require( '@stdlib/string-truncate' );
#### truncate( str, len\[, ending] )
Truncates a string to a specified length.
`javascript`
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:
`javascript
var out = truncate( 'beep boop', 7, '!' );
// returns 'beep b!'
out = truncate( 'beep boop', 7, '!!!' );
// returns 'beep!!!'
`
`javascript
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...'
`
- [@stdlib/string-truncate-cli][@stdlib/string-truncate-cli]: CLI package for use as a command-line utility.
- [@stdlib/string-truncate-middle][@stdlib/string/truncate-middle]: truncate a string in the middle to a specified length.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[@stdlib/string-truncate-cli]: https://www.npmjs.com/package/@stdlib/string-truncate-cli
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-truncate.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-truncate
[test-image]: https://github.com/stdlib-js/string-truncate/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/string-truncate/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-truncate/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-truncate?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/string-truncate#cli
[cli-url]: https://github.com/stdlib-js/string-truncate/tree/cli
[@stdlib/string-truncate]: https://github.com/stdlib-js/string-truncate/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/string-truncate/tree/deno
[deno-readme]: https://github.com/stdlib-js/string-truncate/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/string-truncate/tree/umd
[umd-readme]: https://github.com/stdlib-js/string-truncate/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/string-truncate/tree/esm
[esm-readme]: https://github.com/stdlib-js/string-truncate/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/string-truncate/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-truncate/main/LICENSE
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[@stdlib/string/truncate-middle]: https://www.npmjs.com/package/@stdlib/string-truncate-middle