overtake 1.3.0 → 1.3.1

package/README.md

@@ -112,10 +112,12 @@ benchmark('local', () => 1)
 
 // Programmatic usage – provide baseUrl
 const suite = new Benchmark('local');
-suite.target('helper', async () => {
-  const { helper } = await import('./helpers.js');
-  return { helper };
-});
+suite
+  .target('helper', async () => {
+    const { helper } = await import('./helpers.js');
+    return { helper };
+  })
+  .measure('use helper', ({ helper }) => helper());
 await suite.execute({ baseUrl: import.meta.url });
 ```
 
@@ -127,16 +129,15 @@ When using `npx overtake`, a global `benchmark` function is provided:
 
 ```typescript
 // benchmark.ts - No imports needed!
-benchmark('small', () => generateSmallData())
-  .feed('large', () => generateLargeData())
-  .target('algorithm A')
-  .measure('process', (_, input) => {
-    processA(input);
-  })
-  .target('algorithm B')
-  .measure('process', (_, input) => {
-    processB(input);
-  });
+const suite = benchmark('small', () => generateSmallData()).feed('large', () => generateLargeData());
+
+suite.target('algorithm A').measure('process', (_, input) => {
+  processA(input);
+});
+
+suite.target('algorithm B').measure('process', (_, input) => {
+  processB(input);
+});
 ```
 
 ```bash
@@ -171,21 +172,32 @@ printTableReports(reports);
 
 ```typescript
 // Create with initial feed
-benchmark('initial data', () => data)
-  .feed('more data', () => moreData) // Add more datasets
+const suite = benchmark('initial data', () => data).feed('more data', () => moreData); // Add more datasets
 
-  // Define what to compare
-  .target('implementation A')
-  .measure('operation', (ctx, input) => {
-    /* ... */
-  })
+// Define what to compare
+suite.target('implementation A').measure('operation', (ctx, input) => {
+  /* ... */
+});
 
-  .target('implementation B')
-  .measure('operation', (ctx, input) => {
-    /* ... */
-  });
+suite.target('implementation B').measure('operation', (ctx, input) => {
+  /* ... */
+});
 ```
 
+### Method Chaining Reference
+
+```
+benchmark(name, feedFn) -> Benchmark
+  .feed(name, feedFn)   -> Benchmark
+  .target(name, setup?) -> Target
+    .teardown(fn)       -> Target
+    .measure(name, fn)  -> Measure
+      .pre(fn)          -> Measure
+      .post(fn)         -> Measure
+```
+
+Note: `.measure()` returns `Measure`, not `Benchmark`. To add multiple targets, call `suite.target()` separately for each.
+
 ### Targets with Setup
 
 ```typescript
@@ -243,12 +255,18 @@ sumBenchmark.target('reduce').measure('sum', (_, numbers) => {
 
 ```typescript
 // examples/imports.ts - Correct way to import local files
-.target('local files', async () => {
-  const { join } = await import('node:path');
-  const modulePath = join(process.cwd(), './build/myModule.js');
-  const { myFunction } = await import(modulePath);
-  return { myFunction };
-})
+const suite = benchmark('local modules', () => testData);
+
+suite
+  .target('local files', async () => {
+    const { join } = await import('node:path');
+    const modulePath = join(process.cwd(), './build/myModule.js');
+    const { myFunction } = await import(modulePath);
+    return { myFunction };
+  })
+  .measure('call function', ({ myFunction }, input) => {
+    myFunction(input);
+  });
 ```
 
 **[📁 See all examples](./examples/):**

package/context7.json

@@ -0,0 +1,4 @@
+{
+  "url": "https://context7.com/3axap4ehko/overtake",
+  "public_key": "pk_cWMMIaGchuWIje6ayobfY"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "overtake",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "NodeJS performance benchmark",
   "type": "module",
   "types": "build/index.d.ts",