summaryrefslogtreecommitdiff
path: root/node_modules/cli-cursor/index.d.ts
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /node_modules/cli-cursor/index.d.ts
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'node_modules/cli-cursor/index.d.ts')
-rw-r--r--node_modules/cli-cursor/index.d.ts45
1 files changed, 45 insertions, 0 deletions
diff --git a/node_modules/cli-cursor/index.d.ts b/node_modules/cli-cursor/index.d.ts
new file mode 100644
index 0000000..2b252d0
--- /dev/null
+++ b/node_modules/cli-cursor/index.d.ts
@@ -0,0 +1,45 @@
+/// <reference types="node"/>
+
+/**
+Show cursor.
+
+@param stream - Default: `process.stderr`.
+
+@example
+```
+import * as cliCursor from 'cli-cursor';
+
+cliCursor.show();
+```
+*/
+export function show(stream?: NodeJS.WritableStream): void;
+
+/**
+Hide cursor.
+
+@param stream - Default: `process.stderr`.
+
+@example
+```
+import * as cliCursor from 'cli-cursor';
+
+cliCursor.hide();
+```
+*/
+export function hide(stream?: NodeJS.WritableStream): void;
+
+/**
+Toggle cursor visibility.
+
+@param force - Is useful to show or hide the cursor based on a boolean.
+@param stream - Default: `process.stderr`.
+
+@example
+```
+import * as cliCursor from 'cli-cursor';
+
+const unicornsAreAwesome = true;
+cliCursor.toggle(unicornsAreAwesome);
+```
+*/
+export function toggle(force?: boolean, stream?: NodeJS.WritableStream): void;