{"_id":"node-status","_rev":"26-1ea0d6fe3de34d7f948d6aede0882f66","name":"node-status","description":"A live status bar generator for node.js","dist-tags":{"latest":"1.0.0"},"versions":{"0.0.2":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.0.2","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"http://derrickpelletier/node-status.git"},"keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.1.2"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"_id":"node-status@0.0.2","dist":{"shasum":"e169b7d67cb687eab696525c8738a330de203560","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.0.2.tgz","integrity":"sha512-5Q98E2WGdHziUCtBLc2+GDamqkRvsDalVfHF7WBLflbrvticvfEd1KzROqzrn1Cx3NN3vpaCYF9OlnpgElt4qw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDR8Ub4a972rhlZJH+R6Y3APb1MC1lXr7WpZyfOF0dWIAIgVEMnR3Mj6t9bv7CV8Tp5f0ZPswLYwc2E4tRrGm3QS1k="}]},"_from":".","_npmVersion":"1.2.24","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}],"directories":{}},"0.1.2":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.1.2","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"http://github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.1.2"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@0.1.2","dist":{"shasum":"032c829211d6cff9d13965787080a0b58d703b77","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.1.2.tgz","integrity":"sha512-yjvXtpXlQlf2htwTUbRzXI2xM0AGZUsvUlR+o01eWovfbPjNYjXscGZLPZtN/isEafsQ46KRJ8d6rHa3YvOLDg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDQ2jgjzsGIMipwD690XXocD/OfSHIpDP9UAIEnjtPnMAiAjkSA7gq8k0kptOP3BUJ/Px0qzO+JKsrdEY8wyBJGdGQ=="}]},"_from":".","_npmVersion":"1.2.24","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}]},"0.1.3":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.1.3","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"http://github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.1.2"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@0.1.3","dist":{"shasum":"7254e3d152339fa0c2787263651ede28a887c9e9","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.1.3.tgz","integrity":"sha512-ek9rnyY8/7uOtQbbQaKumRrMqDwdHXv0wFnzpYssi48MQROyFkXBTqBFX6P0ebG/WRsU7ljNOK2YQ8hCrtLs5Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC8P9AqOX0xUzqnsM5triUgYgnig/2uuuTFTbF8MrL55gIhAN8H0p/7iQE/0LTnpy7eSOic8wjrg8mKCgFOyUH78UOq"}]},"_from":".","_npmVersion":"1.2.24","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}]},"0.1.4":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.1.4","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"http://github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.2.0"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@0.1.4","dist":{"shasum":"a4cea5105ea9c59cb0cd7e254007102782c48a19","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.1.4.tgz","integrity":"sha512-LptqhKbDCxT+Gqnih62CkFhPFBVrbNdz4aLCN9sedXBshXuhI2nlISZD0h4VK4SfKrCemhmPNUeUu2jKwuyLfg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCagAk8IRpX+ShESOk39g8cwL1QHXjVaFw00qBSlMm70gIgRh8x/GSIjYcbKXyaaGQr63YJUmE/VMPXnOo30RTETCQ="}]},"_from":".","_npmVersion":"1.2.24","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}]},"0.1.5":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.1.5","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"http://github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.2.0"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@0.1.5","dist":{"shasum":"99b4eec0c7cfb7dadbe73ce8ddf968c6bbb4b9b5","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.1.5.tgz","integrity":"sha512-ro4N79Z0c2stOlABlA8DvEx9f3vZqurN3pNB/S6yfN9mbSFXKGXXAfe7BOaRnIcEvpqB5CyT4nFNe7HZ38/ZhQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAGr4uy2NrwU1b0sOIEVI2L8/+NOsdrBx276D3BHxN+OAiASlUulXju7XxQNP73x+xl3xQAVIooeZS2rhDRy6FlGBw=="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}]},"0.1.6":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.1.6","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"http://github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.2.0"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@0.1.6","dist":{"shasum":"36691e5ca2fbc708b414e7827ffe42bf4631efd2","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.1.6.tgz","integrity":"sha512-j7KJG3Gbcp1prAKWvYstFRycgLXnkNDMlequAMEtP97TDgNo7KuHp+Hbtr3TptSgWSvE0YGKYvrVghLPgZeOUg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDwPvcknlKTvOCq3pHoyW2i418gTlmIKXPmEVMqnTSvvgIhANUQ5qBwGNEAd0vVb6nZ606+LvPbAi+BECCQAiQSKIYo"}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}]},"0.1.7":{"name":"node-status","description":"A live status bar generator for node.js","version":"0.1.7","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"git+ssh://git@github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"colors":"*","charm":"~0.2.0"},"devDependencies":{"mocha":"*","chai":"~1.6.0"},"gitHead":"704589ea328ad29e551bd3d529bbe0afc8f2208a","bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@0.1.7","_shasum":"03e814fa06963932eb199f0788f68f12166f911e","_from":".","_npmVersion":"2.14.12","_nodeVersion":"4.2.6","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}],"dist":{"shasum":"03e814fa06963932eb199f0788f68f12166f911e","tarball":"https://registry.npmjs.org/node-status/-/node-status-0.1.7.tgz","integrity":"sha512-GvTwK4F8FlPOSWHWN/H7qumKcuqY8lM1wyTzuSP94dlmPKaoOr4PWUwSzet2NCjpu/VWfl1zsncoitPEPtjJuA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDz6sNHB4uplPA4huWRbZZdzT1uN7LYz75GwPe4g0aonAIgPquxij8qzmz1l0MYcvIhU56frqDAWfX06ev0UzMJvR8="}]},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/node-status-0.1.7.tgz_1459455125242_0.4752860714215785"}},"1.0.0":{"name":"node-status","description":"A live status bar generator for node.js","version":"1.0.0","author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"git+ssh://git@github.com/derrickpelletier/node-status.git"},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"scripts":{"test":"make test"},"engines":{"node":">=0.10"},"main":"status","dependencies":{"charm":"1.0.1","cli-cursor":"^1.0.2","cli-spinners":"0.2.0","colors":"1.1.2"},"devDependencies":{"mocha":"*","chai":"^3.5.0"},"gitHead":"ce46b6ece73eb68df09c20eaaeee5ccd67ee38ef","bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"},"_id":"node-status@1.0.0","_shasum":"7906a7c47a6587d03496bf74ec634abaa03f8e80","_from":".","_npmVersion":"2.14.12","_nodeVersion":"4.2.6","_npmUser":{"name":"derrickpelletier","email":"derrick@dpelletier.com"},"maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}],"dist":{"shasum":"7906a7c47a6587d03496bf74ec634abaa03f8e80","tarball":"https://registry.npmjs.org/node-status/-/node-status-1.0.0.tgz","integrity":"sha512-vYKQTNACHKZRIV64kLuZ3mO2rrwoHUL7GMgEOmUFm4fSntm+guwAlFAhzlNdcMVtyppyR4MnHhaLqTNTHnFawg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHiXabjwCgM52MRe5bxwNXuQ3Y9qrVW+HaiHU/exHoXhAiEAivnKSFl5KAH78fjM0AjL1tSOKT8UUBauQ+Zp0Jr++0M="}]},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/node-status-1.0.0.tgz_1471984055625_0.6598359756171703"}}},"readme":"# node-status\n\nMakes a little stdout status bar. As simple or complex as you need.\n\n```\nnpm install node-status\n```\n\n- [Config](#config)\n- [Item Options](#item-options)\n- [Item Methods](#item-methods)\n- [Patterns](#patterns)\n- [Tokens](#non-item-tokens)\n\n## Example of custom patterns\n![image](https://cl.ly/2m3E2629130X/Screen%20Recording%202016-08-23%20at%2012.46%20PM%20(3).gif)\n\n## Example of steps\n![image](https://d17oy1vhnax1f7.cloudfront.net/items/2S0x2U0S0L1r3a441O1Q/Screen%20Recording%202016-08-23%20at%2012.37%20PM.gif)\n\n## Quickstart\n```javascript\nvar status = require('node-status')\nvar pizzas = status.addItem('pizza')\n\nstatus.start()\n\npizzas.inc()\npizzas.inc(3)\n```\n\n## Config\nStatus accepts the following config options on `start()`:\n+ `invert`: defaults to *false*. Inverts the colors of the bar.\n+ `interval`: defaults to 250. Number of milliseconds per re-draw interval.\n+ `pattern`: optional manual definition for status bar layout. See [Patterns](#patterns)\n\n```javascript\nstatus.start({\n\tinvert: true,\n\tinterval: 200,\n\tpattern: 'Doing work: {uptime}  |  {spinner.cyan}  |  {pizza.bar}'\n})\n```\n\n## Item Options\n\nAll item options are optional.\n\n| option | type | default | notes |\n|---|---|---|---|\n| **count** | `number` | `0` | Can specify a starting count if needed. |\n| **max** | `number` | `null` | Will cause 'count' type to display as `count/max`. ***Required*** for some display types. Can be a number or a function that returns a number. |\n| **custom** | `function` | `null` | a function run when the pattern `{<item>.custom}` is used. Access `this.count` and `this.max` for values if needed. Must return a `string`. |\n| **precision** | `number` | `2` | The precision used in percentages. |\n| **steps** | `Array` | `false` | An array of strings that identify steps for the item. The count of the item identifies the current step. |\n\n## Item Methods\n\n| method | notes |\n|---|---|\n| `inc( Number )` | Increases the count on the item by the desired amount. If no amount is specified, will increase by 1. |\n| `dec( Number )` | Decreases the count on the item by the desired amount. If no amount is specified, will decrease by 1. |\n| `doneStep( success:Boolean, message:String )` | A helper method for when using `steps` on an item. Will stamp the step to the screen with a ✔ when success is `true`, ✖ when false. An optional message can be added which will be appended to the display. See the gif above, or the examples/steps.js |\n\n## Patterns\n\nThe pattern setting in status config can be used to layout your bar as you see fit, if the default doesn't suit you. Simply a string of tokens.\n\nThe pattern:\n\n```\n'Doing work: {uptime}  |  {spinner.cyan}  |  {pizza.bar}'\n```\n\nWould render as:\n```\nDoing work: 10s  |  ⠼  |  [▒▒▒▒▒▒----]\n```\n\nTokens are specified as: `{<token>[.color][.modifier]}`.\n\nAll tokens support colorization with [marak/colors](https://github.com/Marak/colors.js).\n\n### Non-item tokens\n\n| token | modifiers | notes |\n|---|---|---|\n| uptime |  | renders the current uptime of the process. |\n| spinner | spinner types | renders a spinner. Any type available in [cli-spinners](https://github.com/sindresorhus/cli-spinners) can be used. Ex: `{spinner.bouncingBall.cyan}`\n\n### Item tokens\n\nAll items use their `name` as tokens. If you add an item named `pizza`, you can render it in the pattern with `{pizza}`. Simple.\n\n#### Item type modifiers\nThe items have a number of types available to render.\n\n| type | example | |\n|---|---|---|\n| default | `5` or `5/10` | With no type specified, item is rendered as the `count`, or the `count/max` if `max` was specified. |\n| percentage | 15.23% | Renders a simple percentage, requires `max` to be set. Uses the `precision` setting to round the value. |\n| custom | anything | Renders whatever is returned by the specified `custom` function. |\n| bar | `[▒▒▒▒▒-----]` | Renders as a progress bar. Requires `max` to be set. |\n| time | 15s | Uses the count as milliseconds and renders the value as a nicely formatted time. |\n\n\n## Using Console.log alongside status\nRight now, if you have to use `console.log` after the status bar has started, it can be a bit janky because the stdout line isn't cleared when a console.log is run.\n\nYou can utilize an extended console.log by adding this after requiring status.\n```javascript\nconsole = status.console()\n```\n","maintainers":[{"name":"derrickpelletier","email":"derrick@dpelletier.com"}],"time":{"modified":"2022-06-21T22:11:34.089Z","created":"2013-07-15T23:34:45.939Z","0.0.2":"2013-07-15T23:34:47.393Z","0.1.2":"2013-07-16T02:40:47.831Z","0.1.3":"2013-07-31T16:50:37.982Z","0.1.4":"2014-01-29T18:44:57.123Z","0.1.5":"2015-10-18T20:45:27.526Z","0.1.6":"2015-10-30T19:08:56.834Z","0.1.7":"2016-03-31T20:12:05.775Z","1.0.0":"2016-08-23T20:27:35.881Z"},"author":{"name":"Derrick Pelletier","email":"derrick@dpelletier.com","url":"http://dpelletier.com"},"repository":{"type":"git","url":"git+ssh://git@github.com/derrickpelletier/node-status.git"},"readmeFilename":"README.md","users":{"jbeuckm":true,"esatterwhite":true,"glebec":true,"brainmurder":true,"fwestrom":true,"shulerjw":true,"codedungeon":true},"homepage":"http://github.com/derrickpelletier/node-status.git","keywords":["terminal","status","statusbar","bar","console","progress"],"bugs":{"url":"https://github.com/derrickpelletier/node-status/issues"}}