diff options
Diffstat (limited to 'node_modules/cli-cursor/index.d.ts')
-rw-r--r-- | node_modules/cli-cursor/index.d.ts | 45 |
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; |