summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/slice-ansi/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/node_modules/slice-ansi/readme.md')
-rwxr-xr-xtools/node_modules/eslint/node_modules/slice-ansi/readme.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/slice-ansi/readme.md b/tools/node_modules/eslint/node_modules/slice-ansi/readme.md
new file mode 100755
index 0000000000..628eed2e50
--- /dev/null
+++ b/tools/node_modules/eslint/node_modules/slice-ansi/readme.md
@@ -0,0 +1,64 @@
+# slice-ansi [![Build Status](https://travis-ci.org/chalk/slice-ansi.svg?branch=master)](https://travis-ci.org/chalk/slice-ansi) [![XO: Linted](https://img.shields.io/badge/xo-linted-blue.svg)](https://github.com/sindresorhus/xo)
+
+> Slice a string with [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles)
+
+
+## Install
+
+```
+$ npm install slice-ansi
+```
+
+
+## Usage
+
+```js
+const chalk = require('chalk');
+const sliceAnsi = require('slice-ansi');
+
+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])
+
+#### input
+
+Type: `string`
+
+String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk).
+
+#### beginSlice
+
+Type: `number`
+
+Zero-based index at which to begin the slice.
+
+#### endSlice
+
+Type: `number`
+
+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