@thi.ng/bench 3.4.29 → 3.4.31

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-25T14:07:53Z
+- **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

@@ -1,16 +1,5 @@
 <!-- This file is generated - DO NOT EDIT! -->
 <!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
-> [!IMPORTANT]
-> ‼️ Announcing the thi.ng user survey 2024 📋
->
-> [Please participate in the survey here!](https://forms.gle/XacbSDEmQMPZg8197)\
-> (open until end of February)
->
-> **To achieve a better sample size, I'd highly appreciate if you could
-> circulate the link to this survey in your own networks.**
->
-> [Discussion](https://github.com/thi-ng/umbrella/discussions/447)
-
 # ![@thi.ng/bench](https://media.thi.ng/umbrella/banners-20230807/thing-bench.svg?7a8d9aad)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/bench.svg)](https://www.npmjs.com/package/@thi.ng/bench)
@@ -22,7 +11,7 @@
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
-> 🚀 Help me to work full-time on these projects by [sponsoring me on
+> 🚀 Please help me to work full-time on these projects by [sponsoring me on
 > GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
 
 - [About](#about)
@@ -165,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)
@@ -195,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%|
@@ -240,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.29",
+  "version": "3.4.31",
   "description": "Benchmarking & profiling utilities w/ various statistics & formatters (CSV, JSON, Markdown etc.)",
   "type": "module",
   "module": "./index.js",
@@ -35,11 +35,11 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.26"
+    "@thi.ng/api": "^8.9.27"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
-    "@thi.ng/testament": "^0.4.20",
+    "@thi.ng/testament": "^0.4.21",
     "@types/node": "^20.11.17",
     "esbuild": "^0.20.0",
     "rimraf": "^5.0.5",
@@ -119,5 +119,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "6e20f80dd9df1c8055ffa3c1e4d6f7598add0c0b\n"
+  "gitHead": "df9e312af741d87e6b450afcfea6a6e381662b1e\n"
 }