UNPKG

1.67 kBMarkdownView Raw
1# strip-ansi [![Build Status](https://travis-ci.org/chalk/strip-ansi.svg?branch=master)](https://travis-ci.org/chalk/strip-ansi)
2
3> Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
4
5---
6
7<div align="center">
8 <b>
9 <a href="https://tidelift.com/subscription/pkg/npm-strip-ansi?utm_source=npm-strip-ansi&utm_medium=referral&utm_campaign=readme">Get professional support for 'strip-ansi' with a Tidelift subscription</a>
10 </b>
11 <br>
12 <sub>
13 Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
14 </sub>
15</div>
16
17---
18
19## Install
20
21```
22$ npm install strip-ansi
23```
24
25
26## Usage
27
28```js
29const stripAnsi = require('strip-ansi');
30
31stripAnsi('\u001B[4mUnicorn\u001B[0m');
32//=> 'Unicorn'
33
34stripAnsi('\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007');
35//=> 'Click'
36```
37
38
39## Security
40
41To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
42
43
44## Related
45
46- [strip-ansi-cli](https://github.com/chalk/strip-ansi-cli) - CLI for this module
47- [strip-ansi-stream](https://github.com/chalk/strip-ansi-stream) - Streaming version of this module
48- [has-ansi](https://github.com/chalk/has-ansi) - Check if a string has ANSI escape codes
49- [ansi-regex](https://github.com/chalk/ansi-regex) - Regular expression for matching ANSI escape codes
50- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
51
52
53## Maintainers
54
55- [Sindre Sorhus](https://github.com/sindresorhus)
56- [Josh Junon](https://github.com/qix-)
57
58
59## License
60
61MIT