diff options
Diffstat (limited to 'node_modules/cli-truncate/readme.md')
-rw-r--r-- | node_modules/cli-truncate/readme.md | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/node_modules/cli-truncate/readme.md b/node_modules/cli-truncate/readme.md new file mode 100644 index 000000000..72ae44a35 --- /dev/null +++ b/node_modules/cli-truncate/readme.md @@ -0,0 +1,77 @@ +# cli-truncate [](https://travis-ci.org/sindresorhus/cli-truncate) + +> Truncate a string to a specific width in the terminal + +Gracefully handles [ANSI escapes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles). Like a string styled with [`chalk`](https://github.com/chalk/chalk). + + +## Install + +``` +$ npm install --save cli-truncate +``` + + +## Usage + +```js +const cliTruncate = require('cli-truncate'); + +cliTruncate('unicorn', 4); +//=> 'uni…' + +// Truncate at different positions +cliTruncate('unicorn', 4, {position: 'start'}); +//=> '…orn' + +cliTruncate('unicorn', 4, {position: 'middle'}); +//=> 'un…n' + +cliTruncate('\u001b[31municorn\u001b[39m', 4); +//=> '\u001b[31muni\u001b[39m…' + +// Truncate the paragraph to the terminal width +const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.'; +cliTruncate(paragraph, process.stdout.columns)); +//=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…' +``` + + +## API + +### cliTruncate(input, columns, [options]) + +#### input + +Type: `string` + +Text to truncate. + +#### columns + +Type: `number` + +Columns to occupy in the terminal. + +#### options + +Type: `Object` + +##### position + +Type: `string`<br> +Default: `'end'`<br> +Values: `'start'`, `'middle'`, `'end'` + +Position to truncate the string. + + +## Related + +- [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes +- [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |