Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poolifier/tatami-ng
Cross JavaScript runtime benchmarking library and CLI
https://github.com/poolifier/tatami-ng
benchmark browser bun deno javascript node
Last synced: 2 months ago
JSON representation
Cross JavaScript runtime benchmarking library and CLI
- Host: GitHub
- URL: https://github.com/poolifier/tatami-ng
- Owner: poolifier
- License: mit
- Created: 2024-04-06T15:38:49.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-10-10T10:27:13.000Z (3 months ago)
- Last Synced: 2024-10-11T12:32:03.679Z (3 months ago)
- Topics: benchmark, browser, bun, deno, javascript, node
- Language: JavaScript
- Homepage:
- Size: 1.54 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
tatami-ng
Cross JavaScript runtime benchmarking library and CLI
[](https://github.com/poolifier/tatami-ng/graphs/commit-activity)
[](https://www.npmjs.com/package/tatami-ng)
[](https://jsr.io/@poolifier/tatami-ng)
[](https://github.com/poolifier/tatami-ng/actions/workflows/ci.yml)
[](https://makeapullrequest.com)
- CLI and JS library support ✔
- Library API backward compatible with [mitata](https://github.com/evanwashere/mitata) up to version 0.1.14 ✔
- Benchmark latency and throughput ✔
- Support for sync and async benchmark ✔
- Advanced benchmark statistics: significance, error margin, variance, standard deviation, p-quantiles, ... ✔
- Multiple JS runtime support at zero cost abstraction (primary support for node, deno, bun and browsers but works with all JS runtime) ✔
- Support for CommonJS, ESM and TypeScript ✔
## Table of contents
- [Library installation](#library-installation)
- [Node](#node)
- [npmjs](#npmjs)
- [JSR](#jsr)
- [Deno](#deno)
- [Bun](#bun)
- [npmjs](#npmjs-1)
- [JSR](#jsr-1)
- [Browser](#browser)
- [Library usage example](#library-usage-example)
- [CLI installation](#cli-installation)
- [Node](#node-1)
- [Deno](#deno-1)
- [Bun](#bun-1)
- [CLI standalone binary](#cli-standalone-binary)
- [Deno](#deno-2)
- [Bun](#bun-2)
- [CLI usage examples](#cli-usage-examples)
- [Development](#development)
- [License](#license)
## Library installation
### Node
#### npmjs
```shell
npm install tatami-ng
```
#### JSR
```shell
npx jsr add @poolifier/tatami-ng
```
### Deno
```shell
deno add @poolifier/tatami-ng
```
Deno versions >= 1.40.x are supported.
The `--allow-hrtime` permission flag is recommended to allow high-resolution time measurement with Deno v1.x.x.
### Bun
#### npmjs
```shell
bun add tatami-ng
```
#### JSR
```shell
bunx jsr add @poolifier/tatami-ng
```
Bun versions >= 1.x are supported.
### Browser
```js
import {
...
} from 'https://cdn.jsdelivr.net/npm/[email protected]/dist/browser/index.js'
```
## Library usage example
```js
// adapt import to the targeted JS runtime
import { baseline, bench, bmf, group, run } from 'tatami-ng'
bench('noop', () => {})
bench('noop2', () => {})
group('group', () => {
baseline('baseline', () => {})
bench('Date.now()', () => {
Date.now()
})
bench('performance.now()', () => {
performance.now()
})
})
group({ name: 'group2', summary: false }, () => {
bench('new Array(0)', () => {
new Array(0)
})
bench('new Array(1024)', () => {
new Array(1024)
})
})
await run({
units: false, // print units cheatsheet (default: false)
silent: false, // enable/disable stdout output (default: false)
json: false, // enable/disable json output or set json output indentation (default: false)
reporter: bmf // custom reporter function (default: undefined)
file: 'results.json', // write json output to file (default: undefined)
colors: true, // enable/disable colors (default: true)
now: () => 1e6 * performance.now(), // custom nanoseconds timestamp function to replace default one (default: undefined)
samples: 128, // minimum number of benchmark samples (default: 128)
time: 1_000_000_000, // minimum benchmark execution time in nanoseconds (default: 1_000_000_000)
warmup: true, // enable/disable benchmark warmup or set benchmark warmup run(s) (default: true)
warmupTime: 250_000_000, // minimum warmup execution time in nanoseconds (default: 250_000_000)
latency: true, // enable/disable time/iter column (default: true)
throughput: true, // enable/disable iters/s column (default: true)
latencyMinMax: true, // enable/disable latency (min...max) column (default: true)
latencyPercentiles: false, // enable/disable latency percentile columns (default: true)
})
```
The [tests](./tests) directory contains more examples.
## CLI installation
### Node
```shell
npm install tatami-ng -g
```
### Deno
```shell
deno install -g --allow-read --allow-run --allow-sys -n tatami npm:tatami-ng
```
### Bun
```shell
bun add tatami-ng -g
```
Ensure the global installation directory is in your path:
- Unix: `${HOME}/.bun/bin`
- Windows: TODO
## CLI standalone binary
In the cloned repository root directory, run:
### Deno
```shell
bun build:cli:deno
```
### Bun
```shell
bun build:cli:bun
```
The standalone binary in `./dist/` can be moved to a directory in your path.
## CLI usage examples
```shell
tatami --help
```
```shell
tatami --bench 'hexdump ' --bench 'xxd '
```
## Development
The JavaScript runtime environment used for development is [bun](https://bun.sh/).
## License
MIT © [Evan](https://github.com/evanwashere), [Jerome Benoit](https://github.com/jerome-benoit)