{"_id":"progress-estimator","_rev":"2832214","name":"progress-estimator","description":"Animated progress bars with estimated durations","dist-tags":{"latest":"0.3.0"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"time":{"modified":"2022-09-06T15:15:44.000Z","created":"2018-11-24T21:14:39.199Z","0.3.0":"2020-07-07T18:13:26.604Z","0.2.2":"2018-11-26T17:24:51.701Z","0.2.1":"2018-11-26T17:10:19.387Z","0.2.0":"2018-11-26T17:07:04.396Z","0.1.3":"2018-11-26T16:28:29.969Z","0.1.2":"2018-11-26T00:29:05.974Z","0.1.1":"2018-11-24T21:39:36.586Z","0.1.0":"2018-11-24T21:14:39.199Z"},"users":{},"author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"versions":{"0.3.0":{"name":"progress-estimator","version":"0.3.0","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","types":"types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"lint":"eslint 'src/**/*.js' && tsc --project types","prettier":"prettier --write 'src/**/*.js' 'types/**/*.ts'"},"keywords":["ascii","busy","cli","console","duration","idle","indicator","list","loading","progress","promise","task","term","terminal","timing","unicode","wait"],"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","prettier":"^1.15.2","typescript":"^3.1.6"},"gitHead":"b8ec1373371ec25d384aff661395ccd64931d1e9","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.3.0","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"shasum":"b80066764e9e614daf7a01808d00673ab9899634","size":5278,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.3.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.3.0.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.3.0_1594145606469_0.6457830442295418"},"_hasShrinkwrap":false,"publish_time":1594145606604,"_cnpm_publish_time":1594145606604,"_cnpmcore_publish_time":"2021-12-16T11:36:39.578Z"},"0.2.2":{"name":"progress-estimator","version":"0.2.2","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","types":"types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"lint":"eslint 'src/**/*.js' && tsc --project types","prettier":"prettier --write 'src/**/*.js' 'types/**/*.ts'"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","prettier":"^1.15.2","typescript":"^3.1.6"},"gitHead":"63876179a305e7c35d760d2ef17fd6968aaadb09","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.2.2","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"1c3947a5782ea56e40c8fccc290ac7ceeb1b91cb","size":5016,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.2.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.2.2.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.2.2_1543253091579_0.3358714187374263"},"_hasShrinkwrap":false,"publish_time":1543253091701,"_cnpm_publish_time":1543253091701,"_cnpmcore_publish_time":"2021-12-16T11:36:39.776Z"},"0.2.1":{"name":"progress-estimator","version":"0.2.1","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","types":"types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"lint":"eslint 'src/**/*.js' && tsc --project types","prettier":"prettier --write 'src/**/*.js' 'types/**/*.ts'"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","prettier":"^1.15.2","typescript":"^3.1.6"},"gitHead":"a7e23d2bea563907eb7be3961b23bb1ab3452f10","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.2.1","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"deae08447fd858a0bf6a1067c4fbac1b4dad3cb0","size":4718,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.2.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.2.1.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.2.1_1543252219262_0.5562766447756413"},"_hasShrinkwrap":false,"publish_time":1543252219387,"_cnpm_publish_time":1543252219387,"_cnpmcore_publish_time":"2021-12-16T11:36:39.999Z"},"0.2.0":{"name":"progress-estimator","version":"0.2.0","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","types":"types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"lint":"eslint 'src/**/*.js' && tsc --project types","prettier":"prettier --write 'src/**/*.js' 'types/**/*.ts'"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","prettier":"^1.15.2","typescript":"^3.1.6"},"gitHead":"91cdcef9df9bd9180d30211bf68b54f681affcc3","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.2.0","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"6fcb39770f326cad3ad94a73780638af70ed348d","size":4667,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.2.0.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.2.0_1543252024232_0.47481470772731393"},"_hasShrinkwrap":false,"publish_time":1543252024396,"_cnpm_publish_time":1543252024396,"_cnpmcore_publish_time":"2021-12-16T11:36:40.199Z"},"0.1.3":{"name":"progress-estimator","version":"0.1.3","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","types":"types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"lint":"eslint 'src/**/*.js' && tsc --project types","prettier":"prettier --write 'src/**/*.js' 'types/**/*.ts'"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","prettier":"^1.15.2","typescript":"^3.1.6"},"gitHead":"1085f06d33b3c431dd93fa6782ce891fb50d2c9c","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.1.3","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"0f97be7fa4f34671f34f568d29adc2d446860bf0","size":4304,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.1.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.1.3.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.1.3_1543249709871_0.29617134729469474"},"_hasShrinkwrap":false,"publish_time":1543249709969,"_cnpm_publish_time":1543249709969,"_cnpmcore_publish_time":"2021-12-16T11:36:40.509Z"},"0.1.2":{"name":"progress-estimator","version":"0.1.2","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","types":"types/index.d.ts","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"lint":"eslint 'src/**/*.js' && tsc --project types","prettier":"prettier --write 'src/**/*.js' 'types/**/*.ts'"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","prettier":"^1.15.2","typescript":"^3.1.6"},"gitHead":"ae1d855b647e1cc5d97351b1c75e37b10b81de15","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.1.2","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"8095da13023adb4818b5717b2772f648935ab8cf","size":4006,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.1.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.1.2.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.1.2_1543192145880_0.803316089407599"},"_hasShrinkwrap":false,"publish_time":1543192145974,"_cnpm_publish_time":1543192145974,"_cnpmcore_publish_time":"2021-12-16T11:36:40.736Z"},"0.1.1":{"name":"progress-estimator","version":"0.1.1","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","repository":{"type":"git","url":"git+https://github.com/bvaughn/progress-estimator.git"},"bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"scripts":{"linc":"lint-staged","lint":"eslint 'src/**/*.js'","prettier":"prettier --write 'src/**/*.js'"},"lint-staged":{"src/**/*.js":"eslint 'src/**/*.js' --max-warnings 0"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","lint-staged":"^8.1.0","prettier":"^1.15.2"},"gitHead":"feb8eea96ba2276ae6f7c3902d5994a366651327","homepage":"https://github.com/bvaughn/progress-estimator#readme","_id":"progress-estimator@0.1.1","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"7be93392953f4ebf00ab1d217d50aff6a8ff5c22","size":36500,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.1.1.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.1.1_1543095576429_0.4289058114699966"},"_hasShrinkwrap":false,"publish_time":1543095576586,"_cnpm_publish_time":1543095576586,"_cnpmcore_publish_time":"2021-12-16T11:36:40.981Z"},"0.1.0":{"name":"progress-estimator","version":"0.1.0","description":"Animated progress bars with estimated durations","author":{"name":"Brian Vaughn","email":"brian.david.vaughn@gmail.com"},"license":"MIT","main":"src/index.js","scripts":{"linc":"lint-staged","lint":"eslint 'src/**/*.js'","prettier":"prettier --write 'src/**/*.js'"},"lint-staged":{"src/**/*.js":"eslint 'src/**/*.js' --max-warnings 0"},"dependencies":{"chalk":"^2.4.1","cli-spinners":"^1.3.1","humanize-duration":"^3.15.3","log-update":"^2.3.0"},"devDependencies":{"babel-eslint":"^10.0.1","eslint":"^5.9.0","eslint-config-prettier":"^3.3.0","eslint-plugin-prettier":"^3.0.0","lint-staged":"^8.1.0","prettier":"^1.15.2"},"gitHead":"6a4eeddd42225d93f4bc5dd9d87d1b654c1521e3","_id":"progress-estimator@0.1.0","_npmVersion":"6.4.1","_nodeVersion":"10.12.0","_npmUser":{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"},"dist":{"shasum":"91b961b0b6fadb970e01f536d385012e265c2cbe","size":36444,"noattachment":false,"key":"/progress-estimator/-/progress-estimator-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/progress-estimator/download/progress-estimator-0.1.0.tgz"},"maintainers":[{"name":"brianvaughn","email":"briandavidvaughn@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/progress-estimator_0.1.0_1543094079046_0.8556691272788404"},"_hasShrinkwrap":false,"publish_time":1543094079199,"_cnpm_publish_time":1543094079199,"_cnpmcore_publish_time":"2021-12-16T11:36:41.317Z"}},"readme":"# progress-estimator\n\nLogs a progress bar and estimation for how long a Promise will take to complete. This library tracks previous durations in order to provide more accurate estimates over time.\n\n![Demo](https://user-images.githubusercontent.com/29597/48986949-474e2400-f0cf-11e8-86d7-d201f8ad8eca.gif)\n\n## Installation\n\n```shell\n# use npm\nnpm install progress-estimator\n\n# use yarn\nyarn add progress-estimator\n```\n\n## Usage example\n\n```js\nconst createLogger = require('progress-estimator');\nconst { join } = require('path');\n\n// All configuration keys are optional, but it's recommended to specify a storage location.\n// Learn more about configuration options below.\nconst logger = createLogger({\n  storagePath: join(__dirname, '.progress-estimator'),\n});\n\nasync function run() {\n  await logger(promiseOne, \"This is a promise\");\n  await logger(\n    promiseTwo,\n    \"This is another promise. I think it will take about 1 second\",\n    {\n      estimate: 1000\n    }\n  );\n}\n```\n## API\n\n### `createLogger(optionalConfiguration)`\n\nThis method is the default package export. It creates and configures a logger function (documented below). The following configuration options are supported. (They apply only to the logger instance that's returned.)\n\n| name | type | Description |\n| --- | --- | --- |\n| `logFunction` | Function | Custom logging function. Defaults to [`log-update`](https://npmjs.com/package/log-update). Must define `.done()` and `.clear()` methods. |\n| `spinner` | object | Which spinner from the [`cli-spinners`](https://npmjs.com/package/cli-spinners) package to use. Defaults to `dots`. |\n| `storagePath` | string | Where to record durations between runs. Defaults to [`os.tmpdir()`](https://nodejs.org/api/os.html). |\n| `theme` | object | Custom [`chalk`](https://npmjs.com/package/chalk) theme. Look to the [default theme](https://github.com/bvaughn/progress-estimator/blob/master/src/theme.js) for a list of required keys. |\n\n### `logger(promise, labelString, options)`\n\nThis method logs a progress bar and estimated duration for a promise. It requires at least two parameters– a `Promise` and a label (e.g. \"Running tests\"). The label is SHA1 hashed in order to uniquely identify the promise.\n\nAn optional third parameter can be provided as well with the following keys:\n\n| name | type | Description |\n| --- | --- | --- |\n| `estimate` | Number | Estimated duration of promise. (This value is used initially, until a history of actual durations have been recorded.) |\n| `id` | String | Uniquely identifies the promise. This value is needed if the label string is not guaranteed to be unique. |\n","_attachments":{},"homepage":"https://github.com/bvaughn/progress-estimator#readme","bugs":{"url":"https://github.com/bvaughn/progress-estimator/issues"},"license":"MIT"}