# performance-benchmarking

> Performance test your async code with ease

Latest version **0.0.2** (published 2016-05-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install performance-benchmarking
pnpm add performance-benchmarking
yarn add performance-benchmarking
bun add performance-benchmarking
```

## 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.0.2 |
| Published | 2016-05-17 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Daniel Schmidt |
| Maintainers | dschmidt |

## Links

- npm: https://www.npmjs.com/package/performance-benchmarking
- Repository: https://github.com/danielmschmidt/performance-benchmarking
- Homepage: https://github.com/danielmschmidt/performance-benchmarking#readme
- Issues: https://github.com/danielmschmidt/performance-benchmarking/issues
- npm.io page: https://npm.io/package/performance-benchmarking

## Dependencies (1)

- [present](https://npm.io/package/present.md) ^1.0.0

## Recent versions

- 0.0.2 (latest) — 2016-05-17
- 0.0.1 — 2016-05-17

## README

# performance-benchmarking [![Build Status](https://travis-ci.org/DanielMSchmidt/performance-benchmarking.svg?branch=master)](https://travis-ci.org/DanielMSchmidt/performance-benchmarking)

> Performance test your async code with ease


## Motivation

I wrote this library after trying to use [Benchmark.js](https://benchmarkjs.com/) and failing to use it with async code. What this module does is best to be seen in `./example.js`, but shortly summarized it gives you the option to create new Benchmark objects, which wrap your actual test.
Within the test you have an object at your hand, which you may resolve or reject, depending on if your tests fails or performs correctly. What happens under the hood is:

- your test is performed once to see if it exeeds the `maxTime`.
- If not your tests are executed `repetitions` times and you get the results (for now mean time).

It depends highliy on promises, so it will be easy for you to chain the result and bend it to your needs.

## Install

```
$ npm install --save performance-benchmarking
```


## Usage

```js
var Benchmark = require('performance-benchmarking');

var bench = new Benchmark(function (promise) {
	promise.resolve();
});

bench.then(function (result) {
	console.log('Mean time: ', result);
});

```


## API

### Benchmark(function, [options])

#### constructor
Params:

#### function

Params: ```js{ resolve, reject }```

The function to be performance tested

#### options

Type: ```Object```

May take the following keys:

- maxTime (```integer```): longest time inital test may take in ms.
- repetitions (```integer```): amount of repetitions to do for the test

#### options

##### maxTime

Type: `integer`

The time in ms the inital test may take at longest in order not to fail. May be set via prototype on exported object or like this:

```js
var bench = new Benchmark(..., { maxTime: 2000 });
```

Default is 2000ms.

##### repetitions

Type: `integer`

The amount of repetitions the test may take. They are all performed in serial.

```js
var bench = new Benchmark(..., { repetitions: 100 });
```

Default is 100.


## License

MIT © [Daniel Schmidt](http://danielmschmidt.de)

---
_Source: https://npm.io/package/performance-benchmarking · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._