https://github.com/chalk/strip-ansi
Strip ANSI escape codes from a string
https://github.com/chalk/strip-ansi
Last synced: 4 months ago
JSON representation
Strip ANSI escape codes from a string
- Host: GitHub
- URL: https://github.com/chalk/strip-ansi
- Owner: chalk
- License: mit
- Created: 2013-12-07T23:28:59.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2025-01-19T08:09:21.000Z (about 1 year ago)
- Last Synced: 2025-05-06T00:08:39.711Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 414
- Watchers: 12
- Forks: 39
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-micro-npm-packages-zh - strip-ansi
- awesome-micro-npm-packages - strip-ansi - Strip ANSI escape codes. (Modules / String)
- awesome-micro-npm-packages - strip-ansi - Strip ANSI escape codes. (Modules / String)
- fucking-awesome-micro-npm-packages - strip-ansi - Strip ANSI escape codes. (Modules / String)
README
# strip-ansi
> Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string
> [!NOTE]
> Node.js has this built-in now with [`stripVTControlCharacters`](https://nodejs.org/api/util.html#utilstripvtcontrolcharactersstr). The benefit of this package is consistent behavior across Node.js versions and faster improvements. The Node.js version is actually based on this package.
## Install
```sh
npm install strip-ansi
```
## Usage
```js
import stripAnsi from 'strip-ansi';
stripAnsi('\u001B[4mUnicorn\u001B[0m');
//=> 'Unicorn'
stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
//=> 'Click'
```
## 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-)