Noteworthy Programming Masterpiece
    Have ideas to improve npm?Join in the discussion! »

    cli-cursor
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.0 • Public • Published

    cli-cursor Build Status

    Toggle the CLI cursor

    The cursor is gracefully restored if the process exits.

    Install

    $ npm install cli-cursor
    

    Usage

    const cliCursor = require('cli-cursor');
     
    cliCursor.hide();
     
    const unicornsAreAwesome = true;
    cliCursor.toggle(unicornsAreAwesome);

    API

    .show(stream?)

    .hide(stream?)

    .toggle(force?, stream?)

    force

    Useful for showing or hiding the cursor based on a boolean.

    stream

    Type: stream.Writable
    Default: process.stderr


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i cli-cursor

    DownloadsWeekly Downloads

    20,546,171

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    4.37 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar