34 lines
691 B
TypeScript
34 lines
691 B
TypeScript
|
export interface Options {
|
||
|
|
/**
|
||
|
|
Match only the first ANSI escape.
|
||
|
|
|
||
|
|
@default false
|
||
|
|
*/
|
||
|
|
readonly onlyFirst: boolean;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Regular expression for matching ANSI escape codes.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
import ansiRegex from 'ansi-regex';
|
||
|
|
|
||
|
|
ansiRegex().test('\u001B[4mcake\u001B[0m');
|
||
|
|
//=> true
|
||
|
|
|
||
|
|
ansiRegex().test('cake');
|
||
|
|
//=> false
|
||
|
|
|
||
|
|
'\u001B[4mcake\u001B[0m'.match(ansiRegex());
|
||
|
|
//=> ['\u001B[4m', '\u001B[0m']
|
||
|
|
|
||
|
|
'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true}));
|
||
|
|
//=> ['\u001B[4m']
|
||
|
|
|
||
|
|
'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex());
|
||
|
|
//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007']
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
export default function ansiRegex(options?: Options): RegExp;
|