Blame view

node_modules/slice-ansi/readme.md 1.15 KB
f7563de62   Palak Handa   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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)