feat: make minSamples option available per Suite creation (#126)

Author: RafaelGSS

README.md

@@ -110,6 +110,7 @@ A `Suite` manages and executes benchmark functions. It provides two methods: `ad
     * `'time'` - Measures actual execution time for a single run.
   * `useWorkers` {boolean} Whether to run benchmarks in worker threads. **Default:** `false`.
   * `plugins` {Array} Array of plugin instances to use.
+  * `minSamples` {number} Minimum number of samples per round for all benchmarks in the suite. Can be overridden per benchmark. **Default:** `10` samples.
 
 If no `reporter` is provided, results are printed to the console.
 

index.d.ts

@@ -28,6 +28,7 @@ export declare namespace BenchNode {
 		benchmarkMode?: "ops" | "time";
 		useWorkers?: boolean;
 		plugins?: Plugin[];
+		minSamples?: number; // Minimum number of samples per round for all benchmarks
 	}
 
 	interface BenchmarkOptions {

lib/index.js

@@ -109,6 +109,7 @@ class Suite {
 	#useWorkers;
 	#benchmarkMode;
 	#reporterOptions;
+	#minSamples;
 
 	constructor(options = {}) {
 		this.#benchmarks = [];
@@ -140,17 +141,29 @@ class Suite {
 		this.#reporterOptions = options.reporterOptions || {
 			printHeader: true,
 		};
+
+		// Suite-level minSamples option
+		if (options.minSamples !== undefined) {
+			validateNumber(options.minSamples, "options.minSamples", 1);
+			this.#minSamples = options.minSamples;
+		} else {
+			this.#minSamples = defaultBenchOptions.minSamples;
+		}
 	}
 
 	add(name, options, fn) {
 		validateString(name, "name");
 		if (typeof options === "function") {
 			fn = options;
-			options = defaultBenchOptions;
+			options = {
+				...defaultBenchOptions,
+				minSamples: this.#minSamples,
+			};
 		} else {
 			validateObject(options, "options");
 			options = {
 				...defaultBenchOptions,
+				minSamples: this.#minSamples,
 				...options,
 			};
 			// Enforce strict minimum (> 1e-6s). Using EPSILON to make boundary exclusive.

test/basic.js

@@ -44,6 +44,21 @@ describe("API Interface", () => {
 		}
 	});
 
+	it("suite-level minSamples should be a valid number", () => {
+		for (const r of ["ds", {}, () => {}]) {
+			assert.throws(
+				() => {
+					new Suite({ minSamples: r });
+				},
+				{
+					code: "ERR_INVALID_ARG_TYPE",
+				},
+			);
+		}
+		// doesNotThrow
+		new Suite({ minSamples: 20 });
+	});
+
 	describe("suite.add", () => {
 		const bench = new Suite({ reporter: noop });
 		it("name should be an string", () => {

types/types.test-d.ts

@@ -27,6 +27,7 @@ expectType<BenchNode.Suite>(
 );
 expectType<BenchNode.Suite>(new Suite({ reporter: false }));
 expectType<BenchNode.Suite>(new Suite({ reporter: null }));
+expectType<BenchNode.Suite>(new Suite({ minSamples: 20 }));
 
 expectAssignable<BenchNode.SuiteOptions>({});
 expectAssignable<BenchNode.SuiteOptions>({ reporter: chartReport });
@@ -35,8 +36,10 @@ expectAssignable<BenchNode.SuiteOptions>({ useWorkers: false });
 expectAssignable<BenchNode.SuiteOptions>({
 	plugins: [new V8GetOptimizationStatus()],
 });
+expectAssignable<BenchNode.SuiteOptions>({ minSamples: 20 });
 expectNotAssignable<BenchNode.SuiteOptions>({ unknownOption: "test" });
 expectNotAssignable<BenchNode.SuiteOptions>({ reporter: "not-a-function" });
+expectNotAssignable<BenchNode.SuiteOptions>({ minSamples: "not-a-number" });
 
 expectAssignable<BenchNode.BenchmarkOptions>({});
 expectAssignable<BenchNode.BenchmarkOptions>({ minTime: 0.1 });