@weedzcokie/benchmark

benchmark-ts

• benchmark-ts
  • Example:
  • Output
  • Events
    • task-start
    • task-done
    • done

Example:

import { Benchmark } from "@weedzcokie/benchmark";

function cellNumberToName(x: number) {
    let name = "";
    while (x >= 0) {
        name = String.fromCodePoint(x % 26 + 65) + name;
        x = Math.floor(x / 26) - 1;
    }
    return name;
}

const DATA_SIZE = 100000;

const lookups: string[] = [];
for (let i = 0; i < DATA_SIZE; ++i) {
    lookups.push(cellNumberToName(i));
}

function mapAssignment() {
    const map = new Map();
    for (const x of lookups) {
        map.set(x, true);
    }
    return map;
}
function setAssignment() {
    const set = new Set();
    for (const x of lookups) {
        set.add(x);
    }
    return set;
}
function objectAssignment() {
    const object: Record<string, boolean> = {};
    for (const x of lookups) {
        object[x] = true;
    }
    return object;
}

const bench = new Benchmark();
bench.add("Map assignment", mapAssignment);
bench.add("Set assignment", setAssignment);
bench.add("Object assignment", objectAssignment);

await bench.run();

console.table(bench.table());

Output:

┌───────────────────┬────────────┬────────────┬──────────┬────────────────┬────────────────┬───────────────────┐
│      (index)      │ 99th (µs)  │  +/- (µs)  │   Op/s   │ Set assignment │ Map assignment │ Object assignment │
├───────────────────┼────────────┼────────────┼──────────┼────────────────┼────────────────┼───────────────────┤
│  Set assignment   │ '5455.871' │ '1761.586' │ '143.26' │      '-'       │     '1.12'     │      '1.44'       │
│  Map assignment   │ '6651.903' │ '1131.191' │ '127.92' │     '0.89'     │      '-'       │      '1.29'       │
│ Object assignment │ '7741.439' │ '2270.702' │ '99.36'  │     '0.69'     │     '0.78'     │        '-'        │
└───────────────────┴────────────┴────────────┴──────────┴────────────────┴────────────────┴───────────────────┘

Output

We do not print anything. You can listen on the task-start event to know when a task is starting and task-done to know then a task is done.

Example:

bench.on("task-start", task => {
    console.log(`Running task '${task.label}'...`);
});

bench.on("task-done", (task, result) => {
    console.log("Task done:", task.label, result);
});

Events

Typescript everywhere so probably easiest to look at type definitions.

task-start

Fires when a task starts running.

task-done

Fires when a task is done running.

done

Fires when all tasks are done running.