fix: fix reporter type definition

Signed-off-by: Jérôme Benoit <[email protected]>
poolifier · Oct 4, 2024 · 6c2979c · 6c2979c
1 parent 6659808
commit 6c2979c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -45,6 +45,8 @@ export function baseline(
   options?: BenchmarkOptions
 ): void
 
+export function ReporterType<T>(report: Report): T
+
 export function run<T = Report>(options?: {
   now?: () => number
   silent?: boolean
@@ -58,7 +60,7 @@ export function run<T = Report>(options?: {
   latencyPercentiles?: boolean
   json?: number | boolean
   file?: string
-  reporter?: <T>(report: Report) => T // custom reporter
+  reporter?: ReporterType<T> // custom reporter
   units?: boolean
 }): Promise<T>
 

diff --git a/src/reporter/json/bmf.js b/src/reporter/json/bmf.js
@@ -1,3 +1,9 @@
+/**
+ * Bencher Metric Format (BMF).
+ *
+ * @param {Object} report tatami-ng report
+ * @returns {Object} BMF report
+ */
 export const bmf = report => {
   return report.benchmarks
     .filter(benchmark => benchmark.error == null)