closeout/restore-cursor

import restoreCursor from 'closeout/restore-cursor';

FunctionsCopy Anchor Link

defaultCopy Anchor Link

The default export, declared as restoreCursor.

Arrange for the cursor to be shown again however this process ends.

A no-op when neither stream is a terminal: writing escape sequences into a pipe corrupts the output the pipe exists to carry, and the incumbent's fourth case asserts exactly that nothing is written.

The handler goes in the restore phase, which is closeout's answer to upstream's { alwaysLast: true } and a stronger one: alwaysLast is a two-bucket sort over registration order, while a phase is a named position that every other handler — including a plugin's (plugin.ts) — is ordered against by declaration rather than by import order.

function restoreCursor(): void;

Returns void