{"_id":"cli-cursor","_rev":"3373696","name":"cli-cursor","description":"Toggle the CLI cursor","dist-tags":{"latest":"5.0.0"},"maintainers":[{"name":"sindresorhus","email":""}],"time":{"modified":"2024-08-26T02:58:19.000Z","created":"2014-08-31T11:48:41.699Z","5.0.0":"2024-07-26T14:02:26.233Z","4.0.0":"2021-08-23T19:35:19.940Z","3.1.0":"2019-06-11T16:57:35.876Z","3.0.0":"2019-04-09T04:54:54.592Z","2.1.0":"2017-01-09T19:40:10.885Z","2.0.0":"2017-01-09T19:25:42.647Z","1.0.2":"2015-09-18T13:47:26.541Z","1.0.1":"2014-08-31T23:31:41.380Z","1.0.0":"2014-08-31T11:48:41.699Z"},"users":{"ahmed-dinar":true,"insomniaqc":true,"cocorax":true},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"versions":{"5.0.0":{"name":"cli-cursor","version":"5.0.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"type":"module","exports":{"types":"./index.d.ts","default":"./index.js"},"sideEffects":false,"engines":{"node":">=18"},"scripts":{"test":"xo && ava && tsc index.d.ts"},"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^5.0.0"},"devDependencies":{"@types/node":"^20.14.12","ava":"^6.1.3","typescript":"^5.5.4","xo":"^0.59.2"},"ava":{"workerThreads":false},"_id":"cli-cursor@5.0.0","gitHead":"b97e13ef5de9b735fe7cb84eb5550a47f2296664","types":"./index.d.ts","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_nodeVersion":"18.20.2","_npmVersion":"10.6.0","dist":{"shasum":"24a4831ecf5a6b01ddeb32fb71a4b2088b0dce38","size":1927,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-5.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-5.0.0.tgz"},"_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"directories":{},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-cursor_5.0.0_1722002546043_0.7046480980288738"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2024-07-26T14:02:26.233Z","publish_time":1722002546233,"_source_registry_name":"default","_cnpm_publish_time":1722002546233},"4.0.0":{"name":"cli-cursor","version":"4.0.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"funding":"https://github.com/sponsors/sindresorhus","author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"https://sindresorhus.com"},"type":"module","exports":"./index.js","engines":{"node":"^12.20.0 || ^14.13.1 || >=16.0.0"},"scripts":{"test":"xo && ava && tsd"},"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^4.0.0"},"devDependencies":{"@types/node":"^16.7.1","ava":"^3.15.0","tsd":"^0.17.0","xo":"^0.44.0"},"gitHead":"e5722c2b3967dd43f12cc3c4a102f8089e3b7a34","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_id":"cli-cursor@4.0.0","_nodeVersion":"16.7.0","_npmVersion":"7.20.3","dist":{"shasum":"3cecfe3734bf4fe02a8361cbdc0f6fe28c6a57ea","size":2112,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-4.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-4.0.0.tgz"},"_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"directories":{},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-cursor_4.0.0_1629747319834_0.4336124733288802"},"_hasShrinkwrap":false,"publish_time":1629747319940,"_cnpm_publish_time":1629747319940},"3.1.0":{"name":"cli-cursor","version":"3.1.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=8"},"scripts":{"test":"xo && ava && tsd"},"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^3.1.0"},"devDependencies":{"@types/node":"^12.0.7","ava":"^2.1.0","tsd":"^0.7.2","xo":"^0.24.0"},"gitHead":"49edacfb841a9dac691972c2aa5d40dba8e0b56b","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_id":"cli-cursor@3.1.0","_nodeVersion":"8.16.0","_npmVersion":"6.9.0","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"264305a7ae490d1d03bf0c9ba7c925d1753af307","size":2134,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-3.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-3.1.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-cursor_3.1.0_1560272255624_0.6903118486191766"},"_hasShrinkwrap":false,"publish_time":1560272255876,"_cnpm_publish_time":1560272255876},"3.0.0":{"name":"cli-cursor","version":"3.0.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=8"},"scripts":{"test":"xo && ava && tsd"},"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^2.0.0"},"devDependencies":{"@types/node":"^11.13.0","ava":"^1.4.1","tsd":"^0.7.2","xo":"^0.24.0"},"gitHead":"2a72de1ce73c99f44509be7219ebc4eb90bdfa02","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_id":"cli-cursor@3.0.0","_nodeVersion":"8.15.0","_npmVersion":"6.9.0","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"f6cc68b8ae372a18894e59fbf2ae3bd659731c15","size":1917,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-3.0.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cli-cursor_3.0.0_1554785694351_0.7813029275132335"},"_hasShrinkwrap":false,"publish_time":1554785694592,"_cnpm_publish_time":1554785694592},"2.1.0":{"name":"cli-cursor","version":"2.1.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=4"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^2.0.0"},"devDependencies":{"ava":"*","xo":"*"},"xo":{"esnext":true},"gitHead":"5a403335e6b3980a1235b71f8afe1d63ee8c3ce1","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_id":"cli-cursor@2.1.0","_shasum":"b35dac376479facc3e94747d41d0d0f5238ffcb5","_from":".","_npmVersion":"2.15.11","_nodeVersion":"4.6.2","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"b35dac376479facc3e94747d41d0d0f5238ffcb5","size":1729,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-2.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-2.1.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/cli-cursor-2.1.0.tgz_1483990808692_0.16963833128102124"},"directories":{},"publish_time":1483990810885,"_cnpm_publish_time":1483990810885,"_hasShrinkwrap":false},"2.0.0":{"name":"cli-cursor","version":"2.0.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=4"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^2.0.0"},"devDependencies":{"ava":"*","xo":"*"},"xo":{"esnext":true},"gitHead":"eb49635ade57270d824961a6bffe42610fc3bee7","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_id":"cli-cursor@2.0.0","_shasum":"f4c77840ecb2bed38c2672df39e264d54a0c1148","_from":".","_npmVersion":"2.15.11","_nodeVersion":"4.6.2","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"f4c77840ecb2bed38c2672df39e264d54a0c1148","size":1696,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-2.0.0.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/cli-cursor-2.0.0.tgz_1483989942414_0.22937274118885398"},"directories":{},"publish_time":1483989942647,"_cnpm_publish_time":1483989942647,"_hasShrinkwrap":false},"1.0.2":{"name":"cli-cursor","version":"1.0.2","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/cli-cursor.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^1.0.1"},"devDependencies":{"ava":"*","xo":"*"},"gitHead":"6be5a384d90278c66aa30db5ecdec8dc68f17d4f","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","_id":"cli-cursor@1.0.2","_shasum":"64da3f7d56a54412e59794bd62dc35295e8f2987","_from":".","_npmVersion":"2.14.3","_nodeVersion":"4.1.0","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"64da3f7d56a54412e59794bd62dc35295e8f2987","size":1636,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-1.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-1.0.2.tgz"},"maintainers":[{"name":"sindresorhus","email":""}],"directories":{},"publish_time":1442584046541,"_cnpm_publish_time":1442584046541,"_hasShrinkwrap":false},"1.0.1":{"name":"cli-cursor","version":"1.0.1","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git://github.com/sindresorhus/cli-cursor"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^1.0.0"},"devDependencies":{"ava":"0.0.4"},"bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor","_id":"cli-cursor@1.0.1","_shasum":"282b7a20ff03061b7c720e08e4659f47eab34efe","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"maintainers":[{"name":"sindresorhus","email":""}],"dist":{"shasum":"282b7a20ff03061b7c720e08e4659f47eab34efe","size":947,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-1.0.1.tgz"},"directories":{},"publish_time":1409527901380,"_cnpm_publish_time":1409527901380,"_hasShrinkwrap":false},"1.0.0":{"name":"cli-cursor","version":"1.0.0","description":"Toggle the CLI cursor","license":"MIT","repository":{"type":"git","url":"git://github.com/sindresorhus/cli-cursor"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["cli","cursor","ansi","toggle","display","show","hide","term","terminal","console","tty","shell","command-line"],"dependencies":{"restore-cursor":"^1.0.0"},"devDependencies":{"ava":"0.0.4"},"bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"homepage":"https://github.com/sindresorhus/cli-cursor","_id":"cli-cursor@1.0.0","_shasum":"3d9f4365bbc3144b249dd7103b65f3ab0135b528","_from":".","_npmVersion":"1.4.9","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"maintainers":[{"name":"sindresorhus","email":""}],"dist":{"shasum":"3d9f4365bbc3144b249dd7103b65f3ab0135b528","size":938,"noattachment":false,"key":"/cli-cursor/-/cli-cursor-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/cli-cursor/download/cli-cursor-1.0.0.tgz"},"directories":{},"publish_time":1409485721699,"_cnpm_publish_time":1409485721699,"_hasShrinkwrap":false}},"readme":"# cli-cursor\n\n> Toggle the CLI cursor\n\nThe cursor is [gracefully restored](https://github.com/sindresorhus/restore-cursor) if the process exits.\n\n## Install\n\n```sh\nnpm install cli-cursor\n```\n\n## Usage\n\n```js\nimport cliCursor from 'cli-cursor';\n\ncliCursor.hide();\n\nconst unicornsAreAwesome = true;\ncliCursor.toggle(unicornsAreAwesome);\n```\n\n## API\n\n### .show(stream?)\n\n### .hide(stream?)\n\n### .toggle(force?, stream?)\n\n#### force\n\nUseful for showing or hiding the cursor based on a boolean.\n\n#### stream\n\nType: `stream.Writable`\\\nDefault: `process.stderr`\n","_attachments":{},"homepage":"https://github.com/sindresorhus/cli-cursor#readme","bugs":{"url":"https://github.com/sindresorhus/cli-cursor/issues"},"license":"MIT"}