docs(touchstone): images for reports

pebula · Apr 21, 2021 · 7db1730 · 7db1730
1 parent 1281077
commit 7db1730
Show file tree

Hide file tree

Showing 8 changed files with 288 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -7,10 +7,10 @@ Monorepo for node<sup>[1](#footnote1)</sup> libraries. Contain the following lib
 Package       | Version | Documentation  | Source Code
 --------------|---------|----------------|------------
 [@pebula/tom](#pebulatom) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/tom?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/tom) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/tom) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/tom)
-[@pebula/goosetyped](#pebulagoosetyped) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/goosetyped?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/goosetyped) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/goosetyped) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/goosetyped)
-[@pebula/nesbus](#pebulanesbus) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/nesbus?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/nesbus) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/nesbus) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/nesbus)
 [@pebula/touchstone](#pebulatouchstone) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/touchstone?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/touchstone) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/touchstone) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/touchstone)
 [@pebula/decorate](#pebuladecorate) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/decorate?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/decorate) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/decorate) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/decorate)
+[@pebula/goosetyped](#pebulagoosetyped) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/goosetyped?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/goosetyped) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/goosetyped) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/goosetyped)
+[@pebula/nesbus](#pebulanesbus) | [![npm (scoped)](https://img.shields.io/npm/v/@pebula/nesbus?color=green&style=flat-square)](https://www.npmjs.com/package/@pebula/nesbus) | [![Docs](https://img.shields.io/badge/Docs-9cf?style=flat-square&label=‎&logo=Read%20The%20Docs&logoColor=white&color=31A8FF)](https://pebula.github.io/node/nesbus) | [![GitHub](https://img.shields.io/badge/Source_Code-green?style=flat-square&label=‎&logo=github)](https://github.com/pebula/node/tree/main/libs/nesbus)
 
 ## @pebula/tom
 
@@ -20,38 +20,38 @@ A super-fast, type safe, object serialization, validation and mapping
 
 --------------
 
-## @pebula/goosetyped
+## @pebula/touchstone
 
-GooseTyped allows you to focus on building your models more clearly. Simplifying most of the domain specific concepts of mongoose resulting in a modern ORM code which in turn, allows taking advantage of modern JS features and design patterns.
+Metadata-driven benchmarking framework, built on top of [benchmark.js](https://benchmarkjs.com/)
 
-[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/goosetyped)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/goosetyped?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/goosetyped)
+[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/touchstone)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/touchstone?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/touchstone)
 
 --------------
 
-## @pebula/nesbus
+## @pebula/decorate
 
-Hassle free service bus integration.
-Provides a code-first approach to service bus entity management including provisioning.
-With additional plugin system your service bus can now be turned CQRS with minimal effort.
-Setting up service bus is now as simple as setting up an express server!
+Strictly typed decorator management tool for metadata driven libraries / applications.
 
-[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/nesbus)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/nesbus?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/nesbus)
+[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/decorate)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/decorate?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/decorate)
 
 --------------
 
-## @pebula/touchstone
+## @pebula/goosetyped
 
-Metadata-driven benchmarking framework, built on top of [benchmark.js](https://benchmarkjs.com/)
+GooseTyped allows you to focus on building your models more clearly. Simplifying most of the domain specific concepts of mongoose resulting in a modern ORM code which in turn, allows taking advantage of modern JS features and design patterns.
 
-[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/touchstone)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/touchstone?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/touchstone)
+[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/goosetyped)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/goosetyped?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/goosetyped)
 
 --------------
 
-## @pebula/decorate
+## @pebula/nesbus
 
-Strictly typed decorator management tool for metadata driven libraries / applications.
+Hassle free service bus integration.
+Provides a code-first approach to service bus entity management including provisioning.
+With additional plugin system your service bus can now be turned CQRS with minimal effort.
+Setting up service bus is now as simple as setting up an express server!
 
-[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/decorate)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/decorate?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/decorate)
+[![Documentation](https://img.shields.io/badge/Documentation-9cf?style=for-the-badge)](https://pebula.github.io/node/nesbus)   ![npm (scoped)](https://img.shields.io/npm/v/@pebula/nesbus?color=green&style=for-the-badge)  [![GitHub](https://img.shields.io/badge/Source_Code-green?style=for-the-badge&logo=github)](https://github.com/pebula/node/tree/main/libs/nesbus)
 
 --------------
 

diff --git a/apps/docs/touchstone/docs/reporters/chart-js-html-reporter.md b/apps/docs/touchstone/docs/reporters/chart-js-html-reporter.md
@@ -3,6 +3,7 @@ id: chart-js-html-reporter
 title: ChartJS HTML Reporter
 sidebar_label: 4. ChartJS HTML Reporter
 ---
+import useBaseUrl from '@docusaurus/useBaseUrl';
 
 The `ChartJsHtmlReporter` is a charting reporter which outputs an HTML file that uses the `CharJS` charting library.
 
@@ -31,3 +32,5 @@ class MyPerformanceTest extends Mixin(ChartJsHtmlReporter) {
   chartJsHtmlReporterOutputFile = `./my-custom-path.html';
 }
 ```
+
+<img alt="ChartJS HTML Reporter" src={useBaseUrl('img/chartjs-html-report.png')} />
diff --git a/apps/docs/touchstone/docs/reporters/pretty-console-reporter.md b/apps/docs/touchstone/docs/reporters/pretty-console-reporter.md
@@ -3,6 +3,7 @@ id: pretty-console-reporter
 title: Pretty Console Reporter
 sidebar_label: 3. Pretty Console Reporter
 ---
+import useBaseUrl from '@docusaurus/useBaseUrl';
 
 The `PrettyConsoleReporter` is a modern CLI console reporter with colors, indentation, spinner and other nice things...
 
@@ -21,3 +22,5 @@ import './suites'; // make sure all suites are loaded
 class MyPerformanceTest extends Mixin(PrettyConsoleReporter) {
 }
 ```
+
+<img alt="Pretty Console Reporter" src={useBaseUrl('img/pretty-console-report.gif')} />
diff --git a/apps/docs/touchstone/docs/reporters/simple-console-reporter.md b/apps/docs/touchstone/docs/reporters/simple-console-reporter.md
@@ -3,6 +3,7 @@ id: simple-console-reporter
 title: Simple Console Reporter
 sidebar_label: 2. Simple Console Reporter
 ---
+import useBaseUrl from '@docusaurus/useBaseUrl';
 
 The `SimpleConsoleReporter` is a simple CLI console reporter that display the default `benchmark.js` case result statistics.
 
@@ -11,3 +12,5 @@ The `SimpleConsoleReporter` is a simple CLI console reporter that display the de
 | Import        | import { SimpleConsoleReporter } from '@pebula/touchstone' |
 | Dependencies  | None                                                       |
 | Configuration | No                                                         |
+
+<img alt="Simple Console Reporter" src={useBaseUrl('img/simple-console-report.gif')} />
diff --git a/apps/docs/touchstone/static/img/chartjs-html-report.png b/apps/docs/touchstone/static/img/chartjs-html-report.png
diff --git a/apps/docs/touchstone/static/img/pretty-console-report.gif b/apps/docs/touchstone/static/img/pretty-console-report.gif
diff --git a/apps/docs/touchstone/static/img/simple-console-report.gif b/apps/docs/touchstone/static/img/simple-console-report.gif
diff --git a/libs/tom/benchmarks/benchmarks.json b/libs/tom/benchmarks/benchmarks.json
@@ -1492,5 +1492,267 @@
         "hzDeviation": 41616433.19521872
       }
     }
+  },
+  "cee8e1159840a02f892885af99d8acbca6c794ba": {
+    "__commitDate": "2021-04-20T20:04:42.000Z",
+    "__runDate": "2021-04-21T00:31:37.623Z",
+    "Serialization Framework Compare - Basic": {
+      "DeepKit - Serialize": {
+        "timing": {
+          "cycle": 0.051760927224744895,
+          "elapsed": 6.176,
+          "period": 6.265234890626027e-8,
+          "timeStamp": 1618965024044
+        },
+        "stats": {
+          "moe": 4.713579615718509e-10,
+          "rme": 0.7523388504987918,
+          "sem": 2.404887559040056e-10,
+          "deviation": 2.3316249958619204e-9,
+          "mean": 6.265234890626027e-8,
+          "variance": 5.4364751213281e-18,
+          "min": 6.074876570684279e-8,
+          "max": 8.175371136883748e-8,
+          "median": 6.214125577125283e-8
+        },
+        "hz": 15961093.517757626,
+        "hzDeviation": 491805.6505289971
+      },
+      "Tom - Serialize": {
+        "timing": {
+          "cycle": 0.053328906507437615,
+          "elapsed": 6.103,
+          "period": 2.89157465314152e-8,
+          "timeStamp": 1618965030229
+        },
+        "stats": {
+          "moe": 1.2399186744911218e-10,
+          "rme": 0.4288039643534797,
+          "sem": 6.326115686179194e-11,
+          "deviation": 5.866598343199686e-10,
+          "mean": 2.89157465314152e-8,
+          "variance": 3.441697612043331e-19,
+          "min": 2.7853344933778017e-8,
+          "max": 3.1066471436960636e-8,
+          "median": 2.886882671286363e-8
+        },
+        "hz": 34583233.01158975,
+        "hzDeviation": 693132.8085680583
+      },
+      "DeepKit - Deserialize": {
+        "timing": {
+          "cycle": 0.051442807006267,
+          "elapsed": 6.122,
+          "period": 7.276632309124998e-8,
+          "timeStamp": 1618965036338
+        },
+        "stats": {
+          "moe": 3.1966173210205e-10,
+          "rme": 0.4392990033331624,
+          "sem": 1.630927204602296e-10,
+          "deviation": 1.5643304200119967e-9,
+          "mean": 7.276632309124998e-8,
+          "variance": 2.4471296629749103e-18,
+          "min": 7.106923032311633e-8,
+          "max": 8.354482791788492e-8,
+          "median": 7.243061408087314e-8
+        },
+        "hz": 13742621.002657864,
+        "hzDeviation": 272314.50205608876
+      },
+      "Tom - Deserialize": {
+        "timing": {
+          "cycle": 0.051527052173852374,
+          "elapsed": 6.145,
+          "period": 3.11249552542464e-8,
+          "timeStamp": 1618965042466
+        },
+        "stats": {
+          "moe": 9.668837070724753e-11,
+          "rme": 0.3106458143230785,
+          "sem": 4.933080138124874e-11,
+          "deviation": 4.757290202806717e-10,
+          "mean": 3.11249552542464e-8,
+          "variance": 2.263181007372078e-19,
+          "min": 3.0241277204936304e-8,
+          "max": 3.253226959993718e-8,
+          "median": 3.118189539048862e-8
+        },
+        "hz": 32128560.244711332,
+        "hzDeviation": 487578.68071927986
+      }
+    },
+    "Serialization Framework Compare - Nested": {
+      "DeepKit - Serialize": {
+        "timing": {
+          "cycle": 0.05239213860067226,
+          "elapsed": 6.136,
+          "period": 1.1663666146621873e-7,
+          "timeStamp": 1618965048619
+        },
+        "stats": {
+          "moe": 5.32690258246689e-10,
+          "rme": 0.4567091097690336,
+          "sem": 2.7178074400341277e-10,
+          "deviation": 2.5783385256778004e-9,
+          "mean": 1.1663666146621873e-7,
+          "variance": 6.6478295529943726e-18,
+          "min": 1.1165531366389798e-7,
+          "max": 1.234588840770438e-7,
+          "median": 1.1609881208661794e-7
+        },
+        "hz": 8573633.602241164,
+        "hzDeviation": 185164.22979815464
+      },
+      "Tom - Serialize": {
+        "timing": {
+          "cycle": 0.05633160973204362,
+          "elapsed": 6.154,
+          "period": 6.77746065227358e-8,
+          "timeStamp": 1618965054761
+        },
+        "stats": {
+          "moe": 2.2138045216669176e-9,
+          "rme": 3.2664217990321647,
+          "sem": 1.1294921028912846e-9,
+          "deviation": 1.0474478855888953e-8,
+          "mean": 6.77746065227358e-8,
+          "variance": 1.0971470730246476e-16,
+          "min": 6.048995922570959e-8,
+          "max": 1.2411238750525475e-7,
+          "median": 6.37769018276844e-8
+        },
+        "hz": 14754788.722595356,
+        "hzDeviation": 1683249.7880370782
+      },
+      "DeepKit - Deserialize": {
+        "timing": {
+          "cycle": 0.05239437448067517,
+          "elapsed": 6.171,
+          "period": 1.6739577210220918e-7,
+          "timeStamp": 1618965060921
+        },
+        "stats": {
+          "moe": 1.0550315101239256e-9,
+          "rme": 0.6302617425007248,
+          "sem": 5.382813827162886e-10,
+          "deviation": 5.190997666060277e-9,
+          "mean": 1.6739577210220918e-7,
+          "variance": 2.6946456769043238e-17,
+          "min": 1.6072768748582256e-7,
+          "max": 1.889048907916448e-7,
+          "median": 1.664180359556162e-7
+        },
+        "hz": 5973866.528656506,
+        "hzDeviation": 174543.71415302093
+      },
+      "Tom - Deserialize": {
+        "timing": {
+          "cycle": 0.05502600313531839,
+          "elapsed": 6.134,
+          "period": 9.875945513291837e-8,
+          "timeStamp": 1618965067099
+        },
+        "stats": {
+          "moe": 1.0932528509553529e-9,
+          "rme": 1.1069855027895463,
+          "sem": 5.577820668139556e-10,
+          "deviation": 5.172658091261719e-9,
+          "mean": 9.875945513291837e-8,
+          "variance": 2.675639172909533e-17,
+          "min": 9.002966049980975e-8,
+          "max": 1.1490804058832411e-7,
+          "median": 9.837213194489314e-8
+        },
+        "hz": 10125612.76947225,
+        "hzDeviation": 507007.6730379509
+      }
+    },
+    "Serialization Framework Compare - NorthWind": {
+      "DeepKit - Serialize": {
+        "timing": {
+          "cycle": 0.06054070209859156,
+          "elapsed": 5.894,
+          "period": 0.006726744677621284,
+          "timeStamp": 1618965073253
+        },
+        "stats": {
+          "moe": 0.00013439140423433742,
+          "rme": 1.9978668832404827,
+          "sem": 0.00006856704297670276,
+          "deviation": 0.0005777561736255176,
+          "mean": 0.006726744677621284,
+          "variance": 3.3380219616239925e-7,
+          "min": 0.006268207555555555,
+          "max": 0.009680736,
+          "median": 0.006489603
+        },
+        "hz": 148.66031757186013,
+        "hzDeviation": 10.728684965026675
+      },
+      "Tom - Serialize": {
+        "timing": {
+          "cycle": 0.05543495966468253,
+          "elapsed": 5.961,
+          "period": 0.004264227666514041,
+          "timeStamp": 1618965079154
+        },
+        "stats": {
+          "moe": 0.000048451220122638095,
+          "rme": 1.1362249840249836,
+          "sem": 0.00002472001026665209,
+          "deviation": 0.00022656263645403737,
+          "mean": 0.004264227666514041,
+          "variance": 5.1330628237004304e-8,
+          "min": 0.003983255076923077,
+          "max": 0.004980633999999999,
+          "median": 0.004194818282051281
+        },
+        "hz": 234.50905491110632,
+        "hzDeviation": 11.699091485415668
+      },
+      "DeepKit - Deserialize": {
+        "timing": {
+          "cycle": 0.05933844494619667,
+          "elapsed": 5.872,
+          "period": 0.007417305618274583,
+          "timeStamp": 1618965085122
+        },
+        "stats": {
+          "moe": 0.00009297497293081711,
+          "rme": 1.2534871517461483,
+          "sem": 0.000047436210678988325,
+          "deviation": 0.00041625105938095244,
+          "mean": 0.007417305618274583,
+          "variance": 1.732649444357652e-7,
+          "min": 0.00685773425,
+          "max": 0.00911624325,
+          "median": 0.0073106790000000005
+        },
+        "hz": 134.81984583946812,
+        "hzDeviation": 6.78030267953871
+      },
+      "Tom - Deserialize": {
+        "timing": {
+          "cycle": 0.05525674275000002,
+          "elapsed": 5.947,
+          "period": 0.006907092843750002,
+          "timeStamp": 1618965091001
+        },
+        "stats": {
+          "moe": 0.00010941843390048606,
+          "rme": 1.5841459840733885,
+          "sem": 0.00005582573158188064,
+          "deviation": 0.000499320522842968,
+          "mean": 0.006907092843750002,
+          "variance": 2.4932098453217485e-7,
+          "min": 0.00625236175,
+          "max": 0.00991816275,
+          "median": 0.0067879838125000005
+        },
+        "hz": 144.7787111917667,
+        "hzDeviation": 8.822440782609831
+      }
+    }
   }
 }