aboutsummaryrefslogtreecommitdiff
path: root/node_modules/ansi-regex/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/ansi-regex/index.d.ts')
-rw-r--r--node_modules/ansi-regex/index.d.ts33
1 files changed, 33 insertions, 0 deletions
diff --git a/node_modules/ansi-regex/index.d.ts b/node_modules/ansi-regex/index.d.ts
new file mode 100644
index 0000000..50ef64d
--- /dev/null
+++ b/node_modules/ansi-regex/index.d.ts
@@ -0,0 +1,33 @@
+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;