diff options
Diffstat (limited to 'node_modules/cli-cursor/index.d.ts')
-rw-r--r-- | node_modules/cli-cursor/index.d.ts | 47 |
1 files changed, 47 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..bfd4f63 --- /dev/null +++ b/node_modules/cli-cursor/index.d.ts @@ -0,0 +1,47 @@ +declare const cliCursor: { + /** + Show cursor. + + @param stream - Default: `process.stderr`. + + @example + ``` + import cliCursor from 'cli-cursor'; + + cliCursor.show(); + ``` + */ + show(stream?: NodeJS.WritableStream): void; + + /** + Hide cursor. + + @param stream - Default: `process.stderr`. + + @example + ``` + import cliCursor from 'cli-cursor'; + + cliCursor.hide(); + ``` + */ + 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 cliCursor from 'cli-cursor'; + + const unicornsAreAwesome = true; + cliCursor.toggle(unicornsAreAwesome); + ``` + */ + toggle(force?: boolean, stream?: NodeJS.WritableStream): void; +}; + +export default cliCursor; |