restore-cursor

  • Version 5.0.0
  • Published
  • 3.08 kB
  • 2 dependencies
  • MIT license

Install

npm i restore-cursor
yarn add restore-cursor
pnpm add restore-cursor

Overview

Gracefully restore the CLI cursor on exit

Index

Functions

function restoreCursor

restoreCursor: () => void;
  • Gracefully restore the CLI cursor on exit.

    Prevent the cursor you have hidden interactively from remaining hidden if the process crashes.

    It does nothing if run in a non-TTY context.

    Example 1

    import restoreCursor from 'restore-cursor';
    restoreCursor();

Package Files (1)

Dependencies (2)

Dev Dependencies (2)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/restore-cursor.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/restore-cursor)
  • HTML
    <a href="https://www.jsdocs.io/package/restore-cursor"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>