feat: add name to Bench options (#140)

jerome-benoit · web-flow · commit eedc1a3147f3 · 2024-10-18T17:27:57.000+02:00
Signed-off-by: Jérôme Benoit &lt;jerome.benoit@piment-noir.org&gt;
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ benchmark tasks to it.
 ```js
 import { Bench } from 'tinybench';
 
-const bench = new Bench({ time: 100 });
+const bench = new Bench({ name: 'simple benchmark', time: 100 });
 
 bench
   .add('faster task', () => {
@@ -47,9 +47,11 @@ bench
 await bench.warmup(); // make results more reliable
 await bench.run();
 
+console.log(bench.name);
 console.table(bench.table());
 
 // Output:
+// simple benchmark
 // ┌─────────┬───────────────┬────────────────────────────┬───────────────────────────┬──────────────────────┬─────────────────────┬─────────┐
 // │ (index) │ Task name     │ Throughput average (ops/s) │ Throughput median (ops/s) │ Latency average (ns) │ Latency median (ns) │ Samples │
 // ├─────────┼───────────────┼────────────────────────────┼───────────────────────────┼──────────────────────┼─────────────────────┼─────────┤
@@ -79,6 +81,11 @@ Options:
 
 ```ts
 export interface Options {
+  /**
+   * benchmark name
+   */
+  name?: string;
+
   /**
    * time needed for running a benchmark task (milliseconds) @default 500
    */
diff --git a/examples/src/simple.ts b/examples/src/simple.ts
@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 import { Bench } from '../../src';
 
-const bench = new Bench({ time: 100 });
+const bench = new Bench({ name: 'simple benchmark', time: 100 });
 
 bench
   .add('faster task', () => {
@@ -14,9 +14,11 @@ bench
 
 await bench.run();
 
+console.log(bench.name);
 console.table(bench.table());
 
 // Output:
+// simple benchmark
 // ┌─────────┬───────────────┬────────────────────────────┬───────────────────────────┬──────────────────────┬─────────────────────┬─────────┐
 // │ (index) │ Task name     │ Throughput average (ops/s) │ Throughput median (ops/s) │ Latency average (ns) │ Latency median (ns) │ Samples │
 // ├─────────┼───────────────┼────────────────────────────┼───────────────────────────┼──────────────────────┼─────────────────────┼─────────┤
diff --git a/src/bench.ts b/src/bench.ts
@@ -31,6 +31,8 @@ export default class Bench extends EventTarget {
    */
   private readonly _tasks = new Map<string, Task>();
 
+  name?: string;
+
   /**
    * Executes tasks concurrently based on the specified concurrency mode.
    *
@@ -65,6 +67,7 @@ export default class Bench extends EventTarget {
 
   constructor(options: Options = {}) {
     super();
+    this.name = options.name;
     this.now = options.now ?? this.now;
     this.warmupTime = options.warmupTime ?? this.warmupTime;
     this.warmupIterations = options.warmupIterations ?? this.warmupIterations;
diff --git a/src/types.ts b/src/types.ts
@@ -307,6 +307,11 @@ export interface TaskEventsMap {
 }
 
 export interface Options {
+  /**
+   * benchmark name
+   */
+  name?: string;
+
   /**
    * time needed for running a benchmark task (milliseconds) @default 500
    */
