.config/coc/extensions/node_modules/coc-prettier/node_modules/cli-cursor/index.d.ts

   1 /// <reference types="node"/>
   2
   3 /**
   4 Show cursor.
   5
   6 @param stream - Default: `process.stderr`.
   7
   8 @example
   9 ```
  10 import * as cliCursor from 'cli-cursor';
  11
  12 cliCursor.show();
  13 ```
  14 */
  15 export function show(stream?: NodeJS.WritableStream): void;
  16
  17 /**
  18 Hide cursor.
  19
  20 @param stream - Default: `process.stderr`.
  21
  22 @example
  23 ```
  24 import * as cliCursor from 'cli-cursor';
  25
  26 cliCursor.hide();
  27 ```
  28 */
  29 export function hide(stream?: NodeJS.WritableStream): void;
  30
  31 /**
  32 Toggle cursor visibility.
  33
  34 @param force - Is useful to show or hide the cursor based on a boolean.
  35 @param stream - Default: `process.stderr`.
  36
  37 @example
  38 ```
  39 import * as cliCursor from 'cli-cursor';
  40
  41 const unicornsAreAwesome = true;
  42 cliCursor.toggle(unicornsAreAwesome);
  43 ```
  44 */
  45 export function toggle(force?: boolean, stream?: NodeJS.WritableStream): void;