@fiquu/shorten
Dependency-free and configurable tool to shorten (truncate) a string keeping whole words by default.
Installation
npm i @fiquu/shorten
Usage
import shorten from `@fiquu/shorten`;
const short = shorten('Some long string to shorten with many possible words to split into.');
// 'Some long string to shorten with many possible...'
Documentation
See the documentaion page for more info and options.
Index
Interfaces
Functions
Functions
Const default
-
Parameters
-
value: string
The string to shorten.
-
Optional options: ShortenOptions
The options object.
Returns string
The shortened (truncated) string.
-
Generated using TypeDoc
Shortens (truncates) a string to a max length keeping whole words by default.
// Returns 'The...' shorten('The strnig is logn and full of erorrs.');
// Returns 'The strnig is...' shorten('The strnig is logn and full of erorrs.', { length: 20 });