aboutsummaryrefslogtreecommitdiff
path: root/node_modules/slice-ansi/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/slice-ansi/readme.md')
-rwxr-xr-xnode_modules/slice-ansi/readme.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/node_modules/slice-ansi/readme.md b/node_modules/slice-ansi/readme.md
new file mode 100755
index 000000000..31be6124d
--- /dev/null
+++ b/node_modules/slice-ansi/readme.md
@@ -0,0 +1,56 @@
+# slice-ansi
+
+[![Build Status](https://travis-ci.org/vorpaljs/slice-ansi.svg?branch=master)](https://travis-ci.org/vorpaljs/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](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles)
+
+## Install
+
+```
+$ npm install --save slice-ansi
+```
+
+## Usage
+
+```js
+var chalk = require('chalk');
+var sliceAnsi = require('slice-ansi');
+
+var 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`
+
+The zero-based index at which to begin the slice.
+
+#### endSlice
+
+Type: `number`
+
+Optional. The zero-based index at which to end the slice.
+
+
+## Related
+
+- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
+
+
+## License
+
+MIT © [David Caccavella](https://githbu.com/dthree)