You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. declare const cliCursor: {
  2. /**
  3. Show cursor.
  4. @param stream - Default: `process.stderr`.
  5. @example
  6. ```
  7. import cliCursor from 'cli-cursor';
  8. cliCursor.show();
  9. ```
  10. */
  11. show(stream?: NodeJS.WritableStream): void;
  12. /**
  13. Hide cursor.
  14. @param stream - Default: `process.stderr`.
  15. @example
  16. ```
  17. import cliCursor from 'cli-cursor';
  18. cliCursor.hide();
  19. ```
  20. */
  21. hide(stream?: NodeJS.WritableStream): void;
  22. /**
  23. Toggle cursor visibility.
  24. @param force - Is useful to show or hide the cursor based on a boolean.
  25. @param stream - Default: `process.stderr`.
  26. @example
  27. ```
  28. import cliCursor from 'cli-cursor';
  29. const unicornsAreAwesome = true;
  30. cliCursor.toggle(unicornsAreAwesome);
  31. ```
  32. */
  33. toggle(force?: boolean, stream?: NodeJS.WritableStream): void;
  34. };
  35. export default cliCursor;