@thi.ng/bench 3.4.30 → 3.4.31

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-01T15:22:50Z
+- **Last updated**: 2024-03-02T14:05:53Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -154,6 +154,10 @@ Also see the [formatting](#output-formatting) section below for other output
 options. This example uses the default format...
 
 ```ts
+import { benchmark } from "@thi.ng/bench";
+
+// fib() function is from previous example above...
+
 benchmark(() => fib(40), { title: "fib", iter: 10, warmup: 5 });
 // benchmarking: fib
 //         warmup... 3707.17ms (5 runs)
@@ -184,14 +188,18 @@ Multiple benchmarks can be run sequentially as suite (also returns an array of
 all results):
 
 ```ts
-b.suite(
+import { suite, FORMAT_MD } from "@thi.ng/bench";
+
+// fib2() function defined in earlier example above...
+
+suite(
     [
         { title: "fib2(10)", fn: () => fib2(10) },
         { title: "fib2(20)", fn: () => fib2(20) },
         { title: "fib2(30)", fn: () => fib2(30) },
         { title: "fib2(40)", fn: () => fib2(40) },
     ],
-    { iter: 10, size: 100000, warmup: 5, format: b.FORMAT_MD }
+    { iter: 10, size: 100000, warmup: 5, format: FORMAT_MD }
 )
 
 // |                   Title|    Iter|    Size|       Total|    Mean|  Median|     Min|     Max|      Q1|      Q3|     SD%|
@@ -229,6 +237,8 @@ enabled/disabled, supports recursion and estimates/subtracts its internal
 overhead. Results can be obtained as JSON objects or CSV.
 
 ```ts
+import { Profiler } from "@thi.ng/bench";
+
 // initialize with 1million warmup iterations to compute internal overhead (takes around ~100ms)
 const profiler = new Profiler({ warmup: 1e6 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/bench",
-  "version": "3.4.30",
+  "version": "3.4.31",
   "description": "Benchmarking & profiling utilities w/ various statistics & formatters (CSV, JSON, Markdown etc.)",
   "type": "module",
   "module": "./index.js",
@@ -119,5 +119,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "d660ae8fd1bf64d919b4334f19509f1f539d70f6\n"
+  "gitHead": "df9e312af741d87e6b450afcfea6a6e381662b1e\n"
 }