diff options
Diffstat (limited to 'node_modules/slice-ansi/readme.md')
| -rwxr-xr-x | node_modules/slice-ansi/readme.md | 32 |
1 files changed, 20 insertions, 12 deletions
diff --git a/node_modules/slice-ansi/readme.md b/node_modules/slice-ansi/readme.md index 31be6124d..628eed2e5 100755 --- a/node_modules/slice-ansi/readme.md +++ b/node_modules/slice-ansi/readme.md @@ -1,31 +1,31 @@ -# slice-ansi +# slice-ansi [](https://travis-ci.org/chalk/slice-ansi) [](https://github.com/sindresorhus/xo) -[](https://travis-ci.org/vorpaljs/slice-ansi) -[](https://github.com/sindresorhus/xo) +> Slice a string with [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) -> Slice a string with [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) ## Install ``` -$ npm install --save slice-ansi +$ npm install slice-ansi ``` + ## Usage ```js -var chalk = require('chalk'); -var sliceAnsi = require('slice-ansi'); +const chalk = require('chalk'); +const sliceAnsi = require('slice-ansi'); -var input = 'The quick brown ' + chalk.red('fox jumped over ') + +const input = 'The quick brown ' + chalk.red('fox jumped over ') + 'the lazy ' + chalk.green('dog and then ran away with the unicorn.'); console.log(sliceAnsi(input, 20, 30)); ``` + ## API -### sliceAnsi(input, beginSlice[, endSlice]) +### sliceAnsi(input, beginSlice, [endSlice]) #### input @@ -37,20 +37,28 @@ String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/c Type: `number` -The zero-based index at which to begin the slice. +Zero-based index at which to begin the slice. #### endSlice Type: `number` -Optional. The zero-based index at which to end the slice. +Zero-based index at which to end the slice. ## Related +- [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes +- [cli-truncate](https://github.com/sindresorhus/cli-truncate) - Truncate a string to a specific width in the terminal - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right +## Maintainers + +- [Sindre Sorhus](https://github.com/sindresorhus) +- [Josh Junon](https://github.com/qix-) + + ## License -MIT © [David Caccavella](https://githbu.com/dthree) +MIT |