2020-08-25 23:57:08 +00:00
# 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/xojs/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');
2021-02-26 03:58:33 +00:00
const string = 'The quick brown ' + chalk.red('fox jumped over ') +
2020-08-25 23:57:08 +00:00
'the lazy ' + chalk.green('dog and then ran away with the unicorn.');
2021-02-26 03:58:33 +00:00
console.log(sliceAnsi(string, 20, 30));
2020-08-25 23:57:08 +00:00
```
## API
2021-02-26 03:58:33 +00:00
### sliceAnsi(string, beginSlice, endSlice?)
2020-08-25 23:57:08 +00:00
2021-02-26 03:58:33 +00:00
#### string
2020-08-25 23:57:08 +00:00
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- )
2021-02-26 03:58:33 +00:00
---
< div align = "center" >
< b >
< a href = "https://tidelift.com/subscription/pkg/npm-slice_ansi?utm_source=npm-slice-ansi&utm_medium=referral&utm_campaign=readme" > Get professional support for this package with a Tidelift subscription< / a >
< / b >
< br >
< sub >
Tidelift helps make open source sustainable for maintainers while giving companies< br > assurances about security, maintenance, and licensing for their dependencies.
< / sub >
< / div >