Add benchmarkAsync to BenchmarkUtils

USAGE.md

@@ -6,6 +6,7 @@ Here are some of the utility functions and classes available in this library:
 ## Table of Contents
 
 - [BenchmarkUtils](#benchmarkutils)
+  - [benchmarkAsync](#benchmarkasync)
   - [benchmarkIterations](#benchmarkiterations)
   - [benchmark](#benchmark)
 
@@ -89,6 +90,17 @@ Here are some of the utility functions and classes available in this library:
 the following utility functions are available in the `BenchmarkUtils` class, they can be used as a static method on the `BenchmarkUtils` class or as a standalone function.
 
 
+### benchmarkAsync
+```typescript
+/**
+ * Measures the execution time of an asynchronous function.
+ * @param fn - The asynchronous function to be benchmarked.
+ * @param args - The arguments to be passed to the function.
+ * @returns A promise that resolves with the execution time in milliseconds.
+*/
+```
+
+
 ### benchmarkIterations
 ```typescript
 /**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typelegend",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "module": "dist/index.mjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/benchmark/benchmarkAsync.ts

@@ -0,0 +1,17 @@
+/**
+ * Measures the execution time of an asynchronous function.
+ * @param fn - The asynchronous function to be benchmarked.
+ * @param args - The arguments to be passed to the function.
+ * @returns A promise that resolves with the execution time in milliseconds.
+ */
+export function benchmarkAsync(fn: Function, ...args: any[]): Promise<number> {
+  return new Promise((resolve, reject) => {
+    const start = performance.now();
+    fn(...args)
+      .then(() => {
+        const end = performance.now();
+        resolve(end - start);
+      })
+      .catch(reject);
+  });
+}

src/benchmark/index.ts

@@ -1,12 +1,15 @@
 
+import { benchmarkAsync } from "./benchmarkAsync";
 import { benchmarkIterations } from "./benchmarkIterations";
 import { benchmark } from "./benchmark";
 
 export class BenchmarkUtils {
+  static benchmarkAsync: typeof benchmarkAsync = benchmarkAsync;
   static benchmarkIterations: typeof benchmarkIterations = benchmarkIterations;
   static benchmark: typeof benchmark = benchmark;
 }
 
+export { benchmarkAsync } from "./benchmarkAsync";
 export { benchmarkIterations } from "./benchmarkIterations";
 export { benchmark } from "./benchmark";
 

test/benchmark/benchmarkAsync.test.ts

@@ -0,0 +1,22 @@
+import { expect, describe, it } from "bun:test";
+import { benchmarkAsync } from "../../src/benchmark/benchmarkAsync";
+
+describe("benchmarkAsync", () => {
+  it("should measure the execution time of an asynchronous function", async () => {
+    const fn = async () => {
+      setTimeout(() => {}, 1000);
+    };
+
+    const time = await benchmarkAsync(fn);
+    expect(time).toBeGreaterThan(0);
+  });
+
+  it("should measure the execution time of an asynchronous function with arguments", async () => {
+    const fn = async (a: number, b: number) => {
+      setTimeout(() => {}, 1000);
+    };
+
+    const time = await benchmarkAsync(fn, 5, 10);
+    expect(time).toBeGreaterThan(0);
+  });
+});