61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
# strip-ansi [![Build Status](https://travis-ci.org/chalk/strip-ansi.svg?branch=master)](https://travis-ci.org/chalk/strip-ansi)
|
|
|
|
> Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
<b>
|
|
<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>
|
|
</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>
|
|
|
|
---
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install strip-ansi
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const stripAnsi = require('strip-ansi');
|
|
|
|
stripAnsi('\u001B[4mUnicorn\u001B[0m');
|
|
//=> 'Unicorn'
|
|
|
|
stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
|
|
//=> 'Click'
|
|
```
|
|
|
|
|
|
## Security
|
|
|
|
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
|
|
|
|
|
|
## Related
|
|
|
|
- [strip-ansi-cli](https://github.com/chalk/strip-ansi-cli) - CLI for this module
|
|
- [strip-ansi-stream](https://github.com/chalk/strip-ansi-stream) - Streaming version of this module
|
|
- [has-ansi](https://github.com/chalk/has-ansi) - Check if a string has ANSI escape codes
|
|
- [ansi-regex](https://github.com/chalk/ansi-regex) - Regular expression for matching ANSI escape codes
|
|
- [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
|