# bench-chain > benchmark recording - averages & graphs. Latest version **0.5.1** (published 2017-05-10) · MIT license · 0 weekly downloads ## Install ```sh npm install bench-chain pnpm add bench-chain yarn add bench-chain bun add bench-chain ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.5.1 | | Published | 2017-05-10 | | First published | 2017-04-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 14 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 14 | | Author | James | | Maintainers | aretecode | | Keywords | benchmark, ui, average, graph, time, record | ## Links - npm: https://www.npmjs.com/package/bench-chain - Repository: https://github.com/aretecode/bench-chain - Issues: https://github.com/aretecode/bench-chain - npm.io page: https://npm.io/package/bench-chain ## Dependencies (14) - [fliplog](https://npm.io/package/fliplog.md) ^0.2.7 - [flipfile](https://npm.io/package/flipfile.md) * - [fliptime](https://npm.io/package/fliptime.md) ^3.0.2 - [benchmark](https://npm.io/package/benchmark.md) 2.1.4 - [flipchain](https://npm.io/package/flipchain.md) * - [microtime](https://npm.io/package/microtime.md) * - [cli-table2](https://npm.io/package/cli-table2.md) ^0.2.0 - [funwithflags](https://npm.io/package/funwithflags.md) * - [script-chain](https://npm.io/package/script-chain.md) * - [lodash.forown](https://npm.io/package/lodash.forown.md) ^4.4.0 - [lodash.flatten](https://npm.io/package/lodash.flatten.md) ^4.4.0 - [obj-chain-core](https://npm.io/package/obj-chain-core.md) 0.0.7 - [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8 - [obj-chain-plugin-config](https://npm.io/package/obj-chain-plugin-config.md) 0.0.7 ## Alternatives - [@js-joda/timezone](https://npm.io/package/@js-joda/timezone.md) — 383.4K weekly downloads - [chartjs-adapter-moment](https://npm.io/package/chartjs-adapter-moment.md) — 210.8K weekly downloads - [strftime](https://npm.io/package/strftime.md) — 171.2K weekly downloads - [vue-flatpickr-component](https://npm.io/package/vue-flatpickr-component.md) — 115.8K weekly downloads - [timepicker](https://npm.io/package/timepicker.md) — 51.0K weekly downloads ## Recent versions - 0.5.1 (latest) — 2017-05-10 - 0.5.2 (nomicro) — 2017-05-10 - 0.5.0 — 2017-05-08 - 0.4.3 — 2017-05-02 - 0.4.2 — 2017-05-02 - 0.4.1 — 2017-05-02 - 0.4.0 — 2017-05-02 - 0.3.0 — 2017-04-30 - 0.2.0 — 2017-04-29 - 0.1.2 — 2017-04-28 - 0.1.1 — 2017-04-28 - 0.1.0 — 2017-04-27 - 0.0.7 — 2017-04-25 - 0.0.6 — 2017-04-24 - 0.0.5 — 2017-04-24 - … 4 more at https://npm.io/package/bench-chain/versions ## README # 🏋️⛓ bench-chain > chainable benchmark recording - averages & graphs. [![Build Status][travis-image]][travis-url] [![NPM version][bench-chain-npm-image]][bench-chain-npm-url] [![MIT License][license-image]][license-url] [![bench-chain][gitter-badge]][gitter-url] [![Dependencies][david-deps-img]][david-deps-url] [![fluents][fluents-image]][fluents-url] [fluents-image]: https://img.shields.io/badge/⛓-fluent-9659F7.svg [fluents-url]: https://www.npmjs.com/package/flipchain [bench-chain-npm-image]: https://img.shields.io/npm/v/bench-chain.svg [bench-chain-npm-url]: https://npmjs.org/package/bench-chain [license-image]: http://img.shields.io/badge/license-mit-blue.svg?style=flat [license-url]: https://spdx.org/licenses/mit [gitter-badge]: https://img.shields.io/gitter/room/bench-chain/pink.svg [gitter-url]: https://gitter.im/bench-chain/Lobby [travis-image]: https://travis-ci.org/${org}/bench-chain.svg?branch=master [travis-url]: https://travis-ci.org/bench-chain/bench-chain [david-deps-img]: https://david-dm.org/bench-chain/bench-chain.svg [david-deps-url]: https://david-dm.org/bench-chain/bench-chain screen shot 2017-04-24 at 5 51 21 am extension of [benchmark.js](https://benchmarkjs.com/) ## 📦 install ```bash yarn add bench-chain npm i bench-chain --save ``` ```js const Bench = require('bench-chain') ``` ## [🌐 documentation](./docs) ## [🔬 tests](./tests) ## [📘 examples](./examples) ### 👋 basic ```js const Bench = require('bench-chain') Bench // location to store benchmarks .init(__dirname, 'basic.json') // tag current benchmarks with, to mark what changes caused differences .tags('v1') // actual benchmarks .add('1 * 1', () => 1 * 1) .add('1 + 1', () => 1 + 1) .run() ``` ### 💍 async ```js const Bench = require('bench-chain') const sleep = sleepDuration => new Promise(resolve => setTimeout(resolve, sleepDuration)) Bench .init().dir(__dirname).filename('asyncs.json').setup() .name('sleepy') .tags('v1,v2') // can also use .add, and then .runAsync() .addAsync('sleep1', async done => { await sleep(1000) done() }) .addAsync('sleep2', async done => { await sleep(2000) done() }) .run() ``` ### 🚩 flags [using funwithflags](https://github.com/aretecode/funwithflags) * `--graph` will show only the graph reporting, rather than run the benchmarks * `--run-times=10` will run the test `10` times ### 📇 metadata
🔋 battery parsing when available - will be used for comparing more benchmark results with averages - amperage (number) - currentCapacity (number) - percent (number) - charging (boolean) - temp (number)
- **mem**: operating system memory, nodejs memory - **num**: operations a second from benchmarkjs hertz - **sampled**: total runs samples from benchmarkjs - **variation**: variation from benchmarkjs - **timesFor**: microtime | performance.now times for beginning & end of each run - **now**: Date.now for changes over time ### graphs for trends and variation screen shot 2017-04-29 at 9 08 50 pm ### grouped by tags screen shot 2017-05-01 at 5 45 33 am ### progress bars ![digress progress](https://cloud.githubusercontent.com/assets/4022631/25579989/ac2dc194-2e31-11e7-832b-75fa16b241e3.gif) --- _Source: https://npm.io/package/bench-chain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._