{"_id":"pace","_rev":"296213","name":"pace","description":"Command-line progress bar and progress metrics.  Helps you measure the 'pace' of a long-running script.","dist-tags":{"latest":"0.0.4"},"maintainers":[{"name":"cpsubrian","email":""}],"time":{"modified":"2023-11-18T07:11:21.000Z","created":"2012-07-31T01:22:39.332Z","0.0.4":"2012-08-24T19:45:46.404Z","0.0.3":"2012-08-24T19:40:20.578Z","0.0.2":"2012-07-31T01:25:48.076Z","0.0.1":"2012-07-31T01:22:39.332Z"},"users":{},"author":{"name":"Brian Link","email":"cpsubrian@gmail.com"},"repository":{"type":"git","url":"git://github.com/cpsubrian/pace.git"},"versions":{"0.0.4":{"author":{"name":"Brian Link","email":"cpsubrian@gmail.com"},"name":"pace","description":"Command-line progress bar and progress metrics.  Helps you measure the 'pace' of a long-running script.","version":"0.0.4","homepage":"http://cantina.github.com","repository":{"type":"git","url":"git://github.com/cpsubrian/pace.git"},"main":"pace.js","scripts":{},"dependencies":{"charm":"~0.1.0"},"devDependencies":{},"optionalDependencies":{},"engines":{"node":"*"},"_id":"pace@0.0.4","dist":{"shasum":"d66405d5f5bc12d25441a6e26c878dbc69e77a77","size":16936,"noattachment":false,"key":"/pace/-/pace-0.0.4.tgz","tarball":"http://name.csiicloud.com:7001/pace/download/pace-0.0.4.tgz"},"maintainers":[{"name":"cpsubrian","email":""}],"directories":{},"_cnpmcore_publish_time":"2021-12-19T13:24:12.776Z","publish_time":1345837546404,"_cnpm_publish_time":1345837546404},"0.0.3":{"author":{"name":"Brian Link","email":"cpsubrian@gmail.com"},"name":"pace","description":"Command-line progress bar and progress metrics.  Helps you measure the 'pace' of a long-running script.","version":"0.0.3","homepage":"http://cantina.github.com","repository":{"type":"git","url":"git://github.com/cpsubrian/pace.git"},"main":"pace.js","scripts":{},"dependencies":{"charm":"~0.1.0"},"devDependencies":{},"optionalDependencies":{},"engines":{"node":"*"},"_id":"pace@0.0.3","dist":{"shasum":"8424435ccce8eb6502160f58e2f03b57c1d4d409","size":16935,"noattachment":false,"key":"/pace/-/pace-0.0.3.tgz","tarball":"http://name.csiicloud.com:7001/pace/download/pace-0.0.3.tgz"},"maintainers":[{"name":"cpsubrian","email":""}],"directories":{},"_cnpmcore_publish_time":"2021-12-19T13:24:12.674Z","publish_time":1345837220578,"_cnpm_publish_time":1345837220578},"0.0.2":{"author":{"name":"Brian Link","email":"cpsubrian@gmail.com"},"name":"pace","description":"Command-line progress bar and progress metrics.  Helps you measure the 'pace' of a long-running script.","version":"0.0.2","homepage":"http://cantina.github.com","repository":{"type":"git","url":"git://github.com/cantina/pace.git"},"main":"pace.js","scripts":{},"dependencies":{"charm":"~0.1.0"},"devDependencies":{},"optionalDependencies":{},"engines":{"node":"*"},"_npmUser":{"name":"cpsubrian","email":"cpsubrian@gmail.com"},"_id":"pace@0.0.2","_engineSupported":true,"_npmVersion":"1.1.24","_nodeVersion":"v0.6.19","_defaultsLoaded":true,"dist":{"shasum":"578f9f06e9e284b9545770d66856b029a4466afc","size":20458,"noattachment":false,"key":"/pace/-/pace-0.0.2.tgz","tarball":"http://name.csiicloud.com:7001/pace/download/pace-0.0.2.tgz"},"maintainers":[{"name":"cpsubrian","email":""}],"directories":{},"_cnpmcore_publish_time":"2021-12-19T13:24:11.755Z","publish_time":1343697948076,"_cnpm_publish_time":1343697948076},"0.0.1":{"author":{"name":"Brian Link","email":"cpsubrian@gmail.com"},"name":"pace","description":"Command-line progress bar and progress metrics.  Helps you measure the 'pace' of a long-running script.","version":"0.0.1","homepage":"http://cantina.github.com","repository":{"type":"git","url":"git://github.com/cantina/pace.git"},"main":"pace.js","scripts":{},"dependencies":{"charm":"~0.1.0","inherits":"~1.0.0"},"devDependencies":{},"optionalDependencies":{},"engines":{"node":"*"},"_npmUser":{"name":"cpsubrian","email":"cpsubrian@gmail.com"},"_id":"pace@0.0.1","_engineSupported":true,"_npmVersion":"1.1.24","_nodeVersion":"v0.6.19","_defaultsLoaded":true,"dist":{"shasum":"170222011b9241428a523d77518a4ef80f86870c","size":20475,"noattachment":false,"key":"/pace/-/pace-0.0.1.tgz","tarball":"http://name.csiicloud.com:7001/pace/download/pace-0.0.1.tgz"},"maintainers":[{"name":"cpsubrian","email":""}],"directories":{},"_cnpmcore_publish_time":"2021-12-19T13:24:10.719Z","publish_time":1343697759332,"_cnpm_publish_time":1343697759332}},"readme":"Pace\n====\n\nA node.js module that outputs a progress bar and other metrics to the command-line.\nIt was originally conceived to help measure the 'pace' of long running scripts.\nWe've used it to optimize scripts that would have taken hours to complete down\nto minutes, without having to wait the hours before knowing that the script\ncould use some optimization.\n\nInstallation\n------------\n```\n$ npm install pace\n```\n\nExample\n-------\nRunning the following code:\n```\nvar total = 50000,\n    count = 0,\n    pace = require('../')(total);\n\nwhile (count++ < total) {\n  pace.op();\n\n  // Cause some work to be done.\n  for (var i = 0; i < 1000000; i++) {\n    count = count;\n  }\n}\n```\n\nWill cause output to your console similar to:\n\n![Sample progress bar output](https://github.com/cantina/pace/raw/master/screenshot.png)\n\nUsage\n-----\n### `Pace` object ###\nThe module exports a factory function to generate instances of `Pace` objects.\nSo `require('pace')(<options>)` creates an instance of `Pace`, passing\n`options` to the constructor.\n\n### Options ###\nOptions can either be an object literal, or an integer.  If its an integer then\nit is the same as passing options with only the `total` specified.\n\n```\nrequire('pace')(100);\n\n// Same as\n\nrequire('pace')({total: 100});\n```\n\nSupported Options:\n\n  * `total` - The total number of operations that _YOUR_ script will execute.\n  * `maxBurden` - The maximum 'burden' that the progress bar should incur. See more about burden below.\n  * `showBurden` - Mostly for debugging.  Show the current burden / skipped steps with the other metrics.\n\n### pace.op([count]) ###\nSignal to pace that an operation was completed in your script by calling\n`pace.op()`.\n\nIf you would rather track the progress in your own logic, you can call\n`pace.op(<count>)` where `<count>` is the current operation interation\n(for example step # 50 of a 100 step process).\n\n### pace.total ###\nIf your script has a dynamic amount of work to do (for example, depending on the\nresults of previous operation there may be more steps to complete), you can\nfreely change the value of pace.total.  Just set the value like: `pace.total = 200`.\n\nBurden\n------\nDepending on how intensive your operations are, calculating, formatting, and\nprinting the progress bar might be much more expensive than the work you\nare doing.  It would be silly if printing a progress bar caused your\njob to take significantly longer than it would have otherwise. _Pace_ tracks\na stat called 'burden', which is basically a percentage of the overall\nexecution time that is being spent inside the progress bar logic itself.\n\nThe default `maxBurden` is `0.5`, which translates to `0.5% of the total execution\ntime`.  If this low burden is causing you to see progress reported less\noften than you would prefer, you can raise it to something like `20` (20%) via\nthe `maxBurden` option.\n\nExamples\n--------\nThe `test/` folder contains some simple test scripts you can run to see the\nprogress bar in action.\n","_attachments":{},"homepage":"http://cantina.github.com"}