UNPKG

strip-ansi/index.d.ts

Version:

349 BTypeScriptView Raw

1/**
2Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string.
3
4@example
5```
6import stripAnsi from 'strip-ansi';
7
8stripAnsi('\u001B[4mUnicorn\u001B[0m');
9//=> 'Unicorn'
10
11stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
12//=> 'Click'
13```
14*/
15export default function stripAnsi(string: string): string;

1	`/**`
2	`Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string.`
3
4	`@example`
5	```
6	`import stripAnsi from 'strip-ansi';`
7
8	`stripAnsi('\u001B[4mUnicorn\u001B[0m');`
9	`//=> 'Unicorn'`
10
11	`stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');`
12	`//=> 'Click'`
13	```
14	`*/`
15	`export default function stripAnsi(string: string): string;`