swiss-ak - npm Package Compare versions

Comparing version 2.3.0 to 2.3.1

package.json

 {
   "name": "swiss-ak",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "author": "Jack Cannon <[e-mail]> (http://c.annon.co.uk/)",
@@ -23,3 +23,3 @@ "license": "MIT",
     "jest": "^28.1.3",
-    "swiss-docs": "0.3.0",
+    "swiss-docs": "^0.4.3",
     "ts-jest": "^28.0.7",
@@ -33,3 +33,3 @@ "tsup": "^6.2.1",
     "watch": "yarn build -- --watch src",
-    "docs": "swiss-docs -i src -o README.md",
+    "docs": "swiss-docs -i src -o README.md -a dist/index.d.ts",
     "test": "yarn build && yarn test:raw",
@@ -36,0 +36,0 @@ "test:raw": "jest --no-cache",

src/index.ts

@@ -17,11 +17,1 @@ export * from './tools/types';
 export * from './tools/queue';
-
-// import * as progressBar from './tools/progressBar';
-// import * as ColourTools from './tools/ColourTools';
-// export * as StringTools from './tools/StringTools';
-
-// export { clx, ClxType } from './tools/StringTools';
-
-// export * as MathsTools from './tools/MathsTools';
-
-// export { progressBar };

src/tools/ArrayTools.ts

@@ -5,9 +5,11 @@ import { fn } from './fn';
 //<!-- DOCS: 100 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: ArrayTools ## -->
  * ArrayTools
  *
+ * - `ArrayTools`
+ *
  * A collection of useful array functions.
  */
 export namespace ArrayTools {
-  /**<!-- DOCS: 101 ### -->
+  /**<!-- DOCS: ArrayTools.utils 101 ### -->
    * utils
@@ -20,3 +22,3 @@ *
   export namespace utils {
-    /**<!-- DOCS: 101 #### -->
+    /**<!-- DOCS: ArrayTools.utils.isNumString 101 #### -->
      * isNumString
@@ -30,3 +32,3 @@ *
 
-    /**<!-- DOCS: 101 #### -->
+    /**<!-- DOCS: ArrayTools.utils.partitionNums 101 #### -->
      * partitionNums
@@ -42,3 +44,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.range ### -->
    * range
@@ -71,3 +73,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.zip ### -->
    * zip
@@ -91,3 +93,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.zipMax ### -->
    * zipMax
@@ -111,3 +113,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.sortByMapped ### -->
    * sortByMapped
@@ -138,3 +140,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.randomise ### -->
    * randomise
@@ -157,3 +159,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.reverse ### -->
    * reverse
@@ -180,3 +182,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.entries ### -->
    * entries
@@ -201,3 +203,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.repeat ### -->
    * repeat
@@ -220,3 +222,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.roll ### -->
    * roll
@@ -239,3 +241,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.sortNumberedText ### -->
    * sortNumberedText
@@ -264,3 +266,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.partition ### -->
    * partition
@@ -286,3 +288,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.groupObj ### -->
    * groupObj
@@ -325,3 +327,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ArrayTools.group ### -->
    * group
@@ -352,27 +354,27 @@ *
 
-/** ALIAS - range */
+/** <!-- DOCS-ALIAS: ArrayTools.range  --> */
 export const range = ArrayTools.range;
-/** ALIAS - zip */
+/** <!-- DOCS-ALIAS: ArrayTools.zip  --> */
 export const zip = ArrayTools.zip;
-/** ALIAS - zipMax */
+/** <!-- DOCS-ALIAS: ArrayTools.zipMax  --> */
 export const zipMax = ArrayTools.zipMax;
-/** ALIAS - sortByMapped */
+/** <!-- DOCS-ALIAS: ArrayTools.sortByMapped  --> */
 export const sortByMapped = ArrayTools.sortByMapped;
-/** ALIAS - randomise */
+/** <!-- DOCS-ALIAS: ArrayTools.randomise  --> */
 export const randomise = ArrayTools.randomise;
-/** ALIAS - reverse */
+/** <!-- DOCS-ALIAS: ArrayTools.reverse  --> */
 export const reverse = ArrayTools.reverse;
-/** ALIAS - entries */
+/** <!-- DOCS-ALIAS: ArrayTools.entries  --> */
 export const entries = ArrayTools.entries;
-/** ALIAS - repeat */
+/** <!-- DOCS-ALIAS: ArrayTools.repeat  --> */
 export const repeat = ArrayTools.repeat;
-/** ALIAS - roll */
+/** <!-- DOCS-ALIAS: ArrayTools.roll  --> */
 export const roll = ArrayTools.roll;
-/** ALIAS - sortNumberedText */
+/** <!-- DOCS-ALIAS: ArrayTools.sortNumberedText  --> */
 export const sortNumberedText = ArrayTools.sortNumberedText;
-/** ALIAS - partition */
+/** <!-- DOCS-ALIAS: ArrayTools.partition  --> */
 export const partition = ArrayTools.partition;
-/** ALIAS - groupObj */
+/** <!-- DOCS-ALIAS: ArrayTools.groupObj  --> */
 export const groupObj = ArrayTools.groupObj;
-/** ALIAS - group */
+/** <!-- DOCS-ALIAS: ArrayTools.group  --> */
 export const group = ArrayTools.group;

src/tools/ColourTools.ts

 import { MathsTools } from './MathsTools';
 
 //<!-- DOCS: 150 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: ColourTools ## -->
  * ColourTools
@@ -10,3 +10,3 @@ *
 export namespace ColourTools {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.ColourValues ### -->
    * ColourValues
@@ -23,3 +23,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.HSLValues ### -->
    * HSLValues
@@ -36,3 +36,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.namedColours ### -->
    * namedColours
@@ -563,3 +563,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.parse ### -->
    * parse
@@ -610,3 +610,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.toHex ### -->
    * toHex
@@ -627,3 +627,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.getLuminance ### -->
    * getLuminance
@@ -653,3 +653,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.toYUV ### -->
    * toYUV
@@ -674,3 +674,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.toHSL ### -->
    * toHSL
@@ -725,3 +725,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.fromHSL ### -->
    * fromHSL
@@ -757,3 +757,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.invertColour ### -->
    * invertColour
@@ -776,3 +776,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.getContrastedColour ### -->
    * getContrastedColour
@@ -793,3 +793,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ColourTools.getLimitedColour ### -->
    * getLimitedColour
@@ -796,0 +796,0 @@ *

src/tools/ErrorTools.ts

@@ -8,3 +8,3 @@ // import { ms, wait, fn }
 //<!-- DOCS: 500 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: ErrorTools ## -->
  * ErrorTools
@@ -15,3 +15,3 @@ *
 export namespace ErrorTools {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ErrorTools.tryOr ### -->
    * tryOr
@@ -36,3 +36,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ErrorTools.retry ### -->
    * retry
@@ -71,3 +71,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ErrorTools.retryOr ### -->
    * retryOr
@@ -95,7 +95,7 @@ *
 
-/** ALIAS - tryOr */
+/** <!-- DOCS-ALIAS: ErrorTools.tryOr  --> */
 export const tryOr = ErrorTools.tryOr;
-/** ALIAS - retry */
+/** <!-- DOCS-ALIAS: ErrorTools.retry  --> */
 export const retry = ErrorTools.retry;
-/** ALIAS - retryOr */
+/** <!-- DOCS-ALIAS: ErrorTools.retryOr  --> */
 export const retryOr = ErrorTools.retryOr;

src/tools/fn.ts

 import { MathsTools } from './MathsTools';
 
 //<!-- DOCS: 30 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: fn ## -->
  * fn
@@ -10,3 +10,3 @@ *
 export namespace fn {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.noop ### -->
    * noop
@@ -25,3 +25,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.noact ### -->
    * noact
@@ -40,3 +40,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.result ### -->
    * result
@@ -58,3 +58,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.resolve ### -->
    * resolve
@@ -73,3 +73,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.reject ### -->
    * reject
@@ -86,3 +86,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.filters ### -->
    * filters
@@ -94,3 +94,3 @@ *
    */
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.exists #### -->
    * exists
@@ -110,3 +110,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isTruthy #### -->
    * isTruthy
@@ -127,3 +127,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isFalsy #### -->
    * isFalsy
@@ -144,3 +144,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isEmpty #### -->
    * isEmpty
@@ -161,3 +161,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isNotEmpty #### -->
    * isNotEmpty
@@ -178,3 +178,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isEqual #### -->
    * isEqual
@@ -197,3 +197,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isNotEqual #### -->
    * isNotEqual
@@ -216,3 +216,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.dedupe #### -->
    * dedupe
@@ -232,3 +232,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.dedupeMapped #### -->
    * dedupeMapped
@@ -254,3 +254,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.maps ### -->
    * maps
@@ -262,3 +262,3 @@ *
    */
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.toString #### -->
    * toString
@@ -278,3 +278,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.toNumber #### -->
    * toNumber
@@ -294,3 +294,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.toBool #### -->
    * toBool
@@ -311,3 +311,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.toProp #### -->
    * toProp
@@ -330,3 +330,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.toFixed #### -->
    * toFixed
@@ -349,3 +349,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.sorts ### -->
    * sorts
@@ -357,3 +357,3 @@ *
    */
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.asc #### -->
    * asc
@@ -377,3 +377,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.desc #### -->
    * desc
@@ -399,3 +399,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.byProp #### -->
    * byProp
@@ -418,3 +418,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.nearestTo #### -->
    * nearestTo
@@ -438,3 +438,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.furthestFrom #### -->
    * furthestFrom
@@ -458,3 +458,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.arrayAsc #### -->
    * arrayAsc
@@ -476,3 +476,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.arrayDesc #### -->
    * arrayDesc
@@ -494,3 +494,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.reduces ### -->
    * reduces
@@ -503,3 +503,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.combine #### -->
    * combine
@@ -520,3 +520,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.combineProp #### -->
    * combineProp
@@ -541,3 +541,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.mode #### -->
    * mode
@@ -568,3 +568,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.modeMapped #### -->
    * modeMapped
@@ -602,3 +602,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: fn.everys ### -->
    * everys
@@ -611,3 +611,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: fn.isAllEqual #### -->
    * isAllEqual
@@ -628,71 +628,71 @@ *
 
-  /** ALIAS - filters */
+  /** <!-- DOCS-ALIAS: fn.filters  --> */
   export namespace filters {
-    /** ALIAS - filters.exists */
+    /** <!-- DOCS-ALIAS: fn.exists  --> */
     export const exists = fn.exists;
-    /** ALIAS - filters.isTruthy */
+    /** <!-- DOCS-ALIAS: fn.isTruthy  --> */
     export const isTruthy = fn.isTruthy;
-    /** ALIAS - filters.isFalsy */
+    /** <!-- DOCS-ALIAS: fn.isFalsy  --> */
     export const isFalsy = fn.isFalsy;
-    /** ALIAS - filters.isEmpty */
+    /** <!-- DOCS-ALIAS: fn.isEmpty  --> */
     export const isEmpty = fn.isEmpty;
-    /** ALIAS - filters.isNotEmpty */
+    /** <!-- DOCS-ALIAS: fn.isNotEmpty  --> */
     export const isNotEmpty = fn.isNotEmpty;
-    /** ALIAS - filters.isEqual */
+    /** <!-- DOCS-ALIAS: fn.isEqual  --> */
     export const isEqual = fn.isEqual;
-    /** ALIAS - filters.isNotEqual */
+    /** <!-- DOCS-ALIAS: fn.isNotEqual  --> */
     export const isNotEqual = fn.isNotEqual;
-    /** ALIAS - filters.dedupe */
+    /** <!-- DOCS-ALIAS: fn.dedupe  --> */
     export const dedupe = fn.dedupe;
-    /** ALIAS - filters.dedupeMapped */
+    /** <!-- DOCS-ALIAS: fn.dedupeMapped  --> */
     export const dedupeMapped = fn.dedupeMapped;
   }
 
-  /** ALIAS - maps */
+  /** <!-- DOCS-ALIAS: fn.maps  --> */
   export namespace maps {
-    /** ALIAS - maps.toString */
+    /** <!-- DOCS-ALIAS: fn.toString  --> */
     export const toString = fn.toString;
-    /** ALIAS - maps.toNumber */
+    /** <!-- DOCS-ALIAS: fn.toNumber  --> */
     export const toNumber = fn.toNumber;
-    /** ALIAS - maps.toBool */
+    /** <!-- DOCS-ALIAS: fn.toBool  --> */
     export const toBool = fn.toBool;
-    /** ALIAS - maps.toProp */
+    /** <!-- DOCS-ALIAS: fn.toProp  --> */
     export const toProp = fn.toProp;
-    /** ALIAS - maps.toFixed */
+    /** <!-- DOCS-ALIAS: fn.toFixed  --> */
     export const toFixed = fn.toFixed;
   }
 
-  /** ALIAS - sorts */
+  /** <!-- DOCS-ALIAS: fn.sorts  --> */
   export namespace sorts {
-    /** ALIAS - sorts.asc */
+    /** <!-- DOCS-ALIAS: fn.asc  --> */
     export const asc = fn.asc;
-    /** ALIAS - sorts.desc */
+    /** <!-- DOCS-ALIAS: fn.desc  --> */
     export const desc = fn.desc;
-    /** ALIAS - sorts.byProp */
+    /** <!-- DOCS-ALIAS: fn.byProp  --> */
     export const byProp = fn.byProp;
-    /** ALIAS - sorts.nearestTo */
+    /** <!-- DOCS-ALIAS: fn.nearestTo  --> */
     export const nearestTo = fn.nearestTo;
-    /** ALIAS - sorts.furthestFrom */
+    /** <!-- DOCS-ALIAS: fn.furthestFrom  --> */
     export const furthestFrom = fn.furthestFrom;
-    /** ALIAS - sorts.arrayAsc */
+    /** <!-- DOCS-ALIAS: fn.arrayAsc  --> */
     export const arrayAsc = fn.arrayAsc;
-    /** ALIAS - sorts.arrayDesc */
+    /** <!-- DOCS-ALIAS: fn.arrayDesc  --> */
     export const arrayDesc = fn.arrayDesc;
   }
 
-  /** ALIAS - reduces */
+  /** <!-- DOCS-ALIAS: fn.reduces  --> */
   export namespace reduces {
-    /** ALIAS - reduces.combine */
+    /** <!-- DOCS-ALIAS: fn.combine  --> */
     export const combine = fn.combine;
-    /** ALIAS - reduces.combineProp */
+    /** <!-- DOCS-ALIAS: fn.combineProp  --> */
     export const combineProp = fn.combineProp;
-    /** ALIAS - reduces.mode */
+    /** <!-- DOCS-ALIAS: fn.mode  --> */
     export const mode = fn.mode;
-    /** ALIAS - reduces.modeMapped */
+    /** <!-- DOCS-ALIAS: fn.modeMapped  --> */
     export const modeMapped = fn.modeMapped;
   }
 
-  /** ALIAS - everys */
+  /** <!-- DOCS-ALIAS: fn.everys  --> */
   export namespace everys {
-    /** ALIAS - everys.isAllEqual */
+    /** <!-- DOCS-ALIAS: fn.isAllEqual  --> */
     export const isAllEqual = fn.isAllEqual;
@@ -702,11 +702,11 @@ }
 
-/** ALIAS - filters */
+/** <!-- DOCS-ALIAS: fn  --> */
 export const filters = fn.filters;
-/** ALIAS - maps */
+/** <!-- DOCS-ALIAS: fn.maps  --> */
 export const maps = fn.maps;
-/** ALIAS - sorts */
+/** <!-- DOCS-ALIAS: fn.sorts  --> */
 export const sorts = fn.sorts;
-/** ALIAS - reduces */
+/** <!-- DOCS-ALIAS: fn.reduces  --> */
 export const reduces = fn.reduces;
-/** ALIAS - everys */
+/** <!-- DOCS-ALIAS: fn.everys  --> */
 export const everys = fn.everys;

src/tools/MathsTools.ts

 import { ArrayTools } from './ArrayTools';
 
 //<!-- DOCS: 130 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: MathsTools ## -->
  * MathsTools
@@ -12,3 +12,3 @@ *
 export namespace MathsTools {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.fixFloat ### -->
    * fixFloat
@@ -33,6 +33,6 @@ *
 
-  /** ALIAS - fixFloat */
+  /** <!-- DOCS-ALIAS: MathsTools.fixFloat  --> */
   export const ff = fixFloat;
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.addAll ### -->
    * addAll
@@ -50,6 +50,6 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.round ### -->
    * round
    */
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: MathsTools.floorTo #### -->
    * floorTo
@@ -70,3 +70,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: MathsTools.roundTo #### -->
    * roundTo
@@ -88,3 +88,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: MathsTools.ceilTo #### -->
    * ceilTo
@@ -113,13 +113,13 @@ *
   export namespace round {
-    /** ALIAS - floorTo */
+    /** <!-- DOCS-ALIAS: MathsTools.floorTo  --> */
     export const floorTo = MathsTools.floorTo;
-    /** ALIAS - roundTo */
+    /** <!-- DOCS-ALIAS: MathsTools.roundTo  --> */
     export const roundTo = MathsTools.roundTo;
-    /** ALIAS - ceilTo */
+    /** <!-- DOCS-ALIAS: MathsTools.ceilTo  --> */
     export const ceilTo = MathsTools.ceilTo;
-    /** ALIAS - roundTo */
+    /** <!-- DOCS-ALIAS: MathsTools.roundTo  --> */
     export const to = MathsTools.roundTo;
   }
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.lerp ### -->
    * lerp
@@ -137,3 +137,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.lerpArray ### -->
    * lerpArray
@@ -152,3 +152,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.lerpObj ### -->
    * lerpObj
@@ -170,3 +170,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.clamp ### -->
    * clamp
@@ -185,3 +185,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: MathsTools.getOrdinal ### -->
    * getOrdinal
@@ -229,3 +229,3 @@ *
 
-/** ALIAS - fixFloat */
+/** <!-- DOCS-ALIAS: MathsTools.fixFloat  --> */
 export const ff = MathsTools.fixFloat;

src/tools/ObjectTools.ts

 import { OfType } from './types';
 
 //<!-- DOCS: 110 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: ObjectTools ## -->
  * ObjectTools
@@ -10,3 +10,3 @@ *
 export namespace ObjectTools {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.remodel ### -->
    * remodel
@@ -28,3 +28,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.remodelEach ### -->
    * remodelEach
@@ -48,3 +48,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.map ### -->
    * map
@@ -65,3 +65,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.mapValues ### -->
    * mapValues
@@ -82,3 +82,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.mapKeys ### -->
    * mapKeys
@@ -97,3 +97,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.filter ### -->
    * filter
@@ -112,3 +112,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: ObjectTools.clean ### -->
    * clean
@@ -115,0 +115,0 @@ *

src/tools/progressBar.ts

@@ -6,19 +6,19 @@ import { fn } from './fn';
 export interface ProgressBar {
-  /** ALIAS - ProgressBar.next */
+  /** <!-- DOCS-ALIAS: progressBar.next  --> */
   next: () => string;
-  /** ALIAS - ProgressBar.set */
+  /** <!-- DOCS-ALIAS: progressBar.set  --> */
   set: (newCurrent: number) => string;
-  /** ALIAS - ProgressBar.reset */
+  /** <!-- DOCS-ALIAS: progressBar.reset  --> */
   reset: () => string;
-  /** ALIAS - ProgressBar.update */
+  /** <!-- DOCS-ALIAS: progressBar.update  --> */
   update: () => string;
-  /** ALIAS - ProgressBar.start */
+  /** <!-- DOCS-ALIAS: progressBar.start  --> */
   start: () => string;
-  /** ALIAS - ProgressBar.finish */
+  /** <!-- DOCS-ALIAS: progressBar.finish  --> */
   finish: () => string;
-  /** ALIAS - ProgressBar.max */
+  /** <!-- DOCS-ALIAS: progressBar.max  --> */
   readonly max: number;
 }
 
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: progressBar ## -->
  * progressBar
@@ -31,3 +31,3 @@ *
 export namespace progressBar {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: progressBar.printLn ### -->
    * printLn
@@ -132,3 +132,3 @@ *
   }
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: progressBar.ProgressBarOptions ### -->
    * Options
@@ -183,3 +183,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: progressBar.getProgressBar ### -->
    * getProgressBar
@@ -229,3 +229,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: progressBar.update #### -->
      * update
@@ -251,3 +251,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: progressBar.next #### -->
      * next
@@ -265,3 +265,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: progressBar.set #### -->
      * set
@@ -279,3 +279,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: progressBar.reset #### -->
      * reset
@@ -291,3 +291,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: progressBar.start #### -->
      * start
@@ -304,3 +304,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: progressBar.finish #### -->
      * finish
@@ -326,2 +326,10 @@ *
       finish,
+
+      /**<!-- DOCS: progressBar.max #### -->
+       * max
+       *
+       * - `getProgressBar().max`
+       *
+       * Readonly number value of the max value (provided to getProgressBar as first argument)
+       */
       max
@@ -332,7 +340,7 @@ };
 
-/** ALIAS - ProgressBarOptions */
+/** <!-- DOCS-ALIAS: progressBar.ProgressBarOptions  --> */
 export type ProgressBarOptions = progressBar.ProgressBarOptions;
-/** ALIAS - printLn */
+/** <!-- DOCS-ALIAS: progressBar.printLn  --> */
 export const printLn = progressBar.printLn;
-/** ALIAS - getProgressBar */
+/** <!-- DOCS-ALIAS: progressBar.getProgressBar  --> */
 export const getProgressBar = progressBar.getProgressBar;

src/tools/PromiseTools.ts

 //<!-- DOCS: 140 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: PromiseTools ## -->
  * PromiseTools
@@ -8,3 +8,3 @@ *
 export namespace PromiseTools {
-  /**<!-- DOCS: 141 ### -->
+  /**<!-- DOCS: PromiseTools.DeferredPromise 141 ### -->
    * DeferredPromise
@@ -22,3 +22,3 @@ *
   }
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.getDeferred ### -->
  * getDeferred
@@ -68,3 +68,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.all ### -->
    * all
@@ -81,3 +81,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.allLimit ### -->
    * allLimit
@@ -167,3 +167,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.each ### -->
    * each
@@ -192,3 +192,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.eachLimit ### -->
    * eachLimit
@@ -226,3 +226,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.map ### -->
    * map
@@ -264,3 +264,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.mapLimit ### -->
    * mapLimit
@@ -309,3 +309,3 @@ *
   type UnWrapPromiseObject<T> = { [K in keyof T]: UnWrapPromise<T[K]> };
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.allObj ### -->
    * allObj
@@ -351,3 +351,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: PromiseTools.allLimitObj ### -->
    * allLimitObj
@@ -400,21 +400,21 @@ *
 
-/** ALIAS - DeferredPromise */
+/** <!-- DOCS-ALIAS: PromiseTools.DeferredPromise  --> */
 export type DeferredPromise<T> = PromiseTools.DeferredPromise<T>;
-/** ALIAS - getDeferred */
+/** <!-- DOCS-ALIAS: PromiseTools.getDeferred  --> */
 export const getDeferred = PromiseTools.getDeferred;
-/** ALIAS - all */
+/** <!-- DOCS-ALIAS: PromiseTools.all  --> */
 export const all = PromiseTools.all;
-/** ALIAS - allLimit */
+/** <!-- DOCS-ALIAS: PromiseTools.allLimit  --> */
 export const allLimit = PromiseTools.allLimit;
-/** ALIAS - each */
+/** <!-- DOCS-ALIAS: PromiseTools.each  --> */
 export const each = PromiseTools.each;
-/** ALIAS - eachLimit */
+/** <!-- DOCS-ALIAS: PromiseTools.eachLimit  --> */
 export const eachLimit = PromiseTools.eachLimit;
-/** ALIAS - map */
+/** <!-- DOCS-ALIAS: PromiseTools.map  --> */
 export const map = PromiseTools.map;
-/** ALIAS - mapLimit */
+/** <!-- DOCS-ALIAS: PromiseTools.mapLimit  --> */
 export const mapLimit = PromiseTools.mapLimit;
-/** ALIAS - allObj */
+/** <!-- DOCS-ALIAS: PromiseTools.allObj  --> */
 export const allObj = PromiseTools.allObj;
-/** ALIAS - allLimitObj */
+/** <!-- DOCS-ALIAS: PromiseTools.allLimitObj  --> */
 export const allLimitObj = PromiseTools.allLimitObj;

src/tools/queue.ts

 import { wait } from './waiters';
 
 //<!-- DOCS: 800 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: queue ## -->
  * queue
@@ -10,3 +10,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: queue.QueueManager ### -->
  * QueueManager
@@ -71,3 +71,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: queue.setDefaultPauseTime #### -->
    * setDefaultPauseTime
@@ -84,3 +84,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: queue.setPauseTime #### -->
    * setPauseTime
@@ -97,3 +97,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: queue.add #### -->
    * add
@@ -119,3 +119,3 @@ *
 
-  /**<!-- DOCS: #### -->
+  /**<!-- DOCS: queue.new #### -->
    * new
@@ -133,3 +133,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: queue.queue ### -->
  * queue
@@ -136,0 +136,0 @@ *

src/tools/StringTools.ts

 //<!-- DOCS: 120 -->
-/**<!-- DOCS: ## -->
+
+export type ClxType = string | boolean | { [key: string]: boolean } | ClxType[];
+
+/**<!-- DOCS: StringTools ## -->
  * StringTools
@@ -8,3 +11,3 @@ *
 export namespace StringTools {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.capitalise ### -->
    * capitalise
@@ -26,3 +29,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.angloise ### -->
    * angloise
@@ -40,3 +43,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.clean ### -->
    * clean
@@ -60,7 +63,7 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.StringCaseHandler ### -->
    * StringCaseHandler
    */
   export interface StringCaseHandler {
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toLowerCamelCase #### -->
      * toLowerCamelCase
@@ -77,3 +80,3 @@ *
     toLowerCamelCase(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toUpperCamelCase #### -->
      * toUpperCamelCase
@@ -90,3 +93,3 @@ *
     toUpperCamelCase(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toCamelCase #### -->
      * toCamelCase
@@ -104,3 +107,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toLowerSlugCase #### -->
      * toLowerSlugCase
@@ -117,3 +120,3 @@ *
     toLowerSlugCase(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toUpperSlugCase #### -->
      * toUpperSlugCase
@@ -130,3 +133,3 @@ *
     toUpperSlugCase(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toSlugCase #### -->
      * toSlugCase
@@ -144,3 +147,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toLowerSnakeCase #### -->
      * toLowerSnakeCase
@@ -157,3 +160,3 @@ *
     toLowerSnakeCase(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toUpperSnakeCase #### -->
      * toUpperSnakeCase
@@ -170,3 +173,3 @@ *
     toUpperSnakeCase(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toSnakeCase #### -->
      * toSnakeCase
@@ -184,3 +187,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toLowerSpaced #### -->
      * toLowerSpaced
@@ -197,3 +200,3 @@ *
     toLowerSpaced(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toUpperSpaced #### -->
      * toUpperSpaced
@@ -210,3 +213,3 @@ *
     toUpperSpaced(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toCapitalisedSpaced #### -->
      * toCapitalisedSpaced
@@ -223,3 +226,3 @@ *
     toCapitalisedSpaced(input: CaseInput): string;
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toSpaced #### -->
      * toSpaced
@@ -237,3 +240,3 @@ *
 
-    /**<!-- DOCS: #### -->
+    /**<!-- DOCS: StringTools.toCharacterSeparated #### -->
      * toCharacterSeparated
@@ -310,37 +313,37 @@ *
   export const {
-    /** ALIAS - toLowerCamelCase */
+    /** <!-- DOCS-ALIAS: StringTools.toLowerCamelCase  --> */
     toLowerCamelCase,
-    /** ALIAS - toUpperCamelCase */
+    /** <!-- DOCS-ALIAS: StringTools.toUpperCamelCase  --> */
     toUpperCamelCase,
-    /** ALIAS - toCamelCase */
+    /** <!-- DOCS-ALIAS: StringTools.toCamelCase  --> */
     toCamelCase,
 
-    /** ALIAS - toLowerSlugCase */
+    /** <!-- DOCS-ALIAS: StringTools.toLowerSlugCase  --> */
     toLowerSlugCase,
-    /** ALIAS - toUpperSlugCase */
+    /** <!-- DOCS-ALIAS: StringTools.toUpperSlugCase  --> */
     toUpperSlugCase,
-    /** ALIAS - toSlugCase */
+    /** <!-- DOCS-ALIAS: StringTools.toSlugCase  --> */
     toSlugCase,
 
-    /** ALIAS - toLowerSnakeCase */
+    /** <!-- DOCS-ALIAS: StringTools.toLowerSnakeCase  --> */
     toLowerSnakeCase,
-    /** ALIAS - toUpperSnakeCase */
+    /** <!-- DOCS-ALIAS: StringTools.toUpperSnakeCase  --> */
     toUpperSnakeCase,
-    /** ALIAS - toSnakeCase */
+    /** <!-- DOCS-ALIAS: StringTools.toSnakeCase  --> */
     toSnakeCase,
 
-    /** ALIAS - toLowerSpaced */
+    /** <!-- DOCS-ALIAS: StringTools.toLowerSpaced  --> */
     toLowerSpaced,
-    /** ALIAS - toUpperSpaced */
+    /** <!-- DOCS-ALIAS: StringTools.toUpperSpaced  --> */
     toUpperSpaced,
-    /** ALIAS - toCapitalisedSpaced */
+    /** <!-- DOCS-ALIAS: StringTools.toCapitalisedSpaced  --> */
     toCapitalisedSpaced,
-    /** ALIAS - toSpaced */
+    /** <!-- DOCS-ALIAS: StringTools.toSpaced  --> */
     toSpaced,
 
-    /** ALIAS - toCharacterSeparated */
+    /** <!-- DOCS-ALIAS: StringTools.toCharacterSeparated  --> */
     toCharacterSeparated
   } = standardCaseHandler;
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.fromSlugCase ### -->
    * fromSlugCase
@@ -366,3 +369,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.fromSnakeCase ### -->
    * fromSnakeCase
@@ -388,3 +391,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.fromSpaced ### -->
    * fromSpaced
@@ -410,3 +413,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.fromCamelCase ### -->
    * fromCamelCase
@@ -463,5 +466,3 @@ *
 
-  export type ClxType = string | boolean | { [key: string]: boolean } | ClxType[];
-
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: StringTools.clx ### -->
    * clx
@@ -487,3 +488,3 @@ *
 
-/** ALIAS - clx */
+/** <!-- DOCS-ALIAS: StringTools.clx  --> */
 export const clx = StringTools.clx;

src/tools/symbols.ts

 //<!-- DOCS: 700 -->
 
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: symbols ## -->
  * symbols
@@ -152,3 +152,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: superscript ### -->
  * superscript
@@ -155,0 +155,0 @@ *

src/tools/timer.ts

@@ -7,3 +7,3 @@ import { ms } from './times';
 //<!-- DOCS: 900 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: timer ## -->
  * timer
@@ -49,3 +49,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: timer.getTimer ### -->
  * getTimer
@@ -200,3 +200,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: timer.timer ### -->
  * timer
@@ -203,0 +203,0 @@ *

src/tools/times.ts

@@ -1,2 +0,2 @@
-/**<!-- DOCS: ## 10 -->
+/**<!-- DOCS: times ## 10 -->
  * times
@@ -22,3 +22,3 @@ *
 export namespace times {
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.ms ### -1 -->
    * ms
@@ -33,3 +33,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.second ### -1 -->
    * second
@@ -44,3 +44,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.minute ### -1 -->
    * minute
@@ -55,3 +55,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.hour ### -1 -->
    * hour
@@ -66,3 +66,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.day ### -1 -->
    * day
@@ -77,3 +77,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.week ### -1 -->
    * week
@@ -88,3 +88,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.month ### -1 -->
    * month
@@ -99,3 +99,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.year ### -1 -->
    * year
@@ -110,3 +110,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.decade ### -1 -->
    * decade
@@ -121,3 +121,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.century ### -1 -->
    * century
@@ -132,3 +132,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.millennium ### -1 -->
    * millennium
@@ -143,3 +143,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.MILLISECOND ### -1 -->
    * MILLISECOND
@@ -156,3 +156,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.SECOND ### -1 -->
    * SECOND
@@ -169,3 +169,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.MINUTE ### -1 -->
    * MINUTE
@@ -182,3 +182,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.HOUR ### -1 -->
    * HOUR
@@ -195,3 +195,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.DAY ### -1 -->
    * DAY
@@ -208,3 +208,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.WEEK ### -1 -->
    * WEEK
@@ -221,3 +221,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.MONTH ### -1 -->
    * MONTH
@@ -234,3 +234,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.YEAR ### -1 -->
    * YEAR
@@ -247,3 +247,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.DECADE ### -1 -->
    * DECADE
@@ -260,3 +260,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.CENTURY ### -1 -->
    * CENTURY
@@ -273,3 +273,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.MILLENNIUM ### -1 -->
    * MILLENNIUM
@@ -286,3 +286,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.milliseconds ### -1 -->
    * milliseconds
@@ -304,3 +304,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.seconds ### -1 -->
    * seconds
@@ -322,3 +322,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.minutes ### -1 -->
    * minutes
@@ -340,3 +340,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.hours ### -1 -->
    * hours
@@ -358,3 +358,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.days ### -1 -->
    * days
@@ -376,3 +376,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.weeks ### -1 -->
    * weeks
@@ -394,3 +394,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.months ### -1 -->
    * months
@@ -412,3 +412,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.years ### -1 -->
    * years
@@ -430,3 +430,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.decades ### -1 -->
    * decades
@@ -448,3 +448,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.centuries ### -1 -->
    * centuries
@@ -466,3 +466,3 @@ *
 
-  /**<!-- DOCS: ### -1 -->
+  /**<!-- DOCS: times.millenniums ### -1 -->
    * millenniums
@@ -485,67 +485,67 @@ *
 
-/** ALIAS - ms */
+/** <!-- DOCS-ALIAS: times.ms  --> */
 export type ms = number;
-/** ALIAS - second */
+/** <!-- DOCS-ALIAS: times.second  --> */
 export type second = number;
-/** ALIAS - minute */
+/** <!-- DOCS-ALIAS: times.minute  --> */
 export type minute = number;
-/** ALIAS - hour */
+/** <!-- DOCS-ALIAS: times.hour  --> */
 export type hour = number;
-/** ALIAS - day */
+/** <!-- DOCS-ALIAS: times.day  --> */
 export type day = number;
-/** ALIAS - week */
+/** <!-- DOCS-ALIAS: times.week --> */
 export type week = number;
-/** ALIAS - month */
+/** <!-- DOCS-ALIAS: times.month  --> */
 export type month = number;
-/** ALIAS - year */
+/** <!-- DOCS-ALIAS: times.year  --> */
 export type year = number;
-/** ALIAS - decade */
+/** <!-- DOCS-ALIAS: times.decade  --> */
 export type decade = number;
-/** ALIAS - century */
+/** <!-- DOCS-ALIAS: times.century  --> */
 export type century = number;
-/** ALIAS - millennium */
+/** <!-- DOCS-ALIAS: times.millennium  --> */
 export type millennium = number;
-/** ALIAS - MILLISECOND */
+/** <!-- DOCS-ALIAS: times.MILLISECOND  --> */
 export const MILLISECOND = times.MILLISECOND;
-/** ALIAS - SECOND */
+/** <!-- DOCS-ALIAS: times.SECOND  --> */
 export const SECOND = times.SECOND;
-/** ALIAS - MINUTE */
+/** <!-- DOCS-ALIAS: times.MINUTE  --> */
 export const MINUTE = times.MINUTE;
-/** ALIAS - HOUR */
+/** <!-- DOCS-ALIAS: times.HOUR  --> */
 export const HOUR = times.HOUR;
-/** ALIAS - DAY */
+/** <!-- DOCS-ALIAS: times.DAY  --> */
 export const DAY = times.DAY;
-/** ALIAS - WEEK */
+/** <!-- DOCS-ALIAS: times.WEEK  --> */
 export const WEEK = times.WEEK;
-/** ALIAS - MONTH */
+/** <!-- DOCS-ALIAS: times.MONTH  --> */
 export const MONTH = times.MONTH;
-/** ALIAS - YEAR */
+/** <!-- DOCS-ALIAS: times.YEAR  --> */
 export const YEAR = times.YEAR;
-/** ALIAS - DECADE */
+/** <!-- DOCS-ALIAS: times.DECADE  --> */
 export const DECADE = times.DECADE;
-/** ALIAS - CENTURY */
+/** <!-- DOCS-ALIAS: times.CENTURY  --> */
 export const CENTURY = times.CENTURY;
-/** ALIAS - MILLENNIUM */
+/** <!-- DOCS-ALIAS: times.MILLENNIUM  --> */
 export const MILLENNIUM = times.MILLENNIUM;
-/** ALIAS - milliseconds */
+/** <!-- DOCS-ALIAS: times.milliseconds  --> */
 export const milliseconds = times.milliseconds;
-/** ALIAS - seconds */
+/** <!-- DOCS-ALIAS: times.seconds  --> */
 export const seconds = times.seconds;
-/** ALIAS - minutes */
+/** <!-- DOCS-ALIAS: times.minutes  --> */
 export const minutes = times.minutes;
-/** ALIAS - hours */
+/** <!-- DOCS-ALIAS: times.hours  --> */
 export const hours = times.hours;
-/** ALIAS - days */
+/** <!-- DOCS-ALIAS: times.days  --> */
 export const days = times.days;
-/** ALIAS - weeks */
+/** <!-- DOCS-ALIAS: times.weeks  --> */
 export const weeks = times.weeks;
-/** ALIAS - months */
+/** <!-- DOCS-ALIAS: times.months  --> */
 export const months = times.months;
-/** ALIAS - years */
+/** <!-- DOCS-ALIAS: times.years  --> */
 export const years = times.years;
-/** ALIAS - decades */
+/** <!-- DOCS-ALIAS: times.decades  --> */
 export const decades = times.decades;
-/** ALIAS - centuries */
+/** <!-- DOCS-ALIAS: times.centuries  --> */
 export const centuries = times.centuries;
-/** ALIAS - millenniums */
+/** <!-- DOCS-ALIAS: times.millenniums  --> */
 export const millenniums = times.millenniums;

src/tools/TimeTools.ts

@@ -63,3 +63,3 @@ import { ms, MILLISECOND, SECOND, MINUTE, HOUR, DAY, MONTH, YEAR, CENTURY, MILLENNIUM } from './times';
 
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: TimeTools ## -->
  * TimeTools
@@ -70,3 +70,3 @@ *
 export namespace TimeTools {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: TimeTools.toReadableDuration ### -->
    * toReadableDuration
@@ -73,0 +73,0 @@ *

src/tools/types.ts

 //<!-- DOCS: 1000 -->
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: types ## -->
  * Helper Types
@@ -8,3 +8,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: types.Partial ### -->
  * Partial<T>
@@ -28,3 +28,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: types.KeysOnly ### -->
  * KeysOnly<T>
@@ -48,3 +48,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: types.Numbered ### -->
  * Numbered<T>
@@ -68,3 +68,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: types.OfType ### -->
  * OfType<T, U>
@@ -80,3 +80,3 @@ *
 
-/**<!-- DOCS: ### -->
+/**<!-- DOCS: types.ObjOfType ### -->
  * ObjOfType<T>
@@ -92,8 +92,8 @@ *
 
-/**<!-- DOCS: ### -->
- * ObjOfType<T>
+/**<!-- DOCS: types.RemapOf ### -->
+ * RemapOf<O, T>
  *
- * - `ObjOfType`
+ * - `RemapOf`
  *
- * An object with any properties of type T
+ * Remap a given interface (O) with all properties of type T
  */
@@ -100,0 +100,0 @@ export type RemapOf<O = Object, T = string> = {

src/tools/waiters.ts

@@ -5,3 +5,3 @@ import { ms } from './times';
 
-/**<!-- DOCS: ## -->
+/**<!-- DOCS: waiters ## -->
  * waiters
@@ -22,3 +22,3 @@ *
 export namespace waiters {
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: waiters.wait ### -->
    * wait
@@ -46,3 +46,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: waiters.waitUntil ### -->
    * waitUntil
@@ -70,3 +70,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: waiters.waitFor ### -->
    * waitFor
@@ -96,3 +96,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: waiters.waitEvery ### -->
    * waitEvery
@@ -116,3 +116,3 @@ *
   const stopped: number[] = [];
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: waiters.stopInterval ### -->
    * stopInterval
@@ -137,3 +137,3 @@ *
 
-  /**<!-- DOCS: ### -->
+  /**<!-- DOCS: waiters.interval ### -->
    * interval
@@ -174,13 +174,13 @@ *
 
-/** ALIAS - wait */
+/** <!-- DOCS-ALIAS: waiters.wait  --> */
 export const wait = waiters.wait;
-/** ALIAS - waitUntil */
+/** <!-- DOCS-ALIAS: waiters.waitUntil  --> */
 export const waitUntil = waiters.waitUntil;
-/** ALIAS - waitFor */
+/** <!-- DOCS-ALIAS: waiters.waitFor  --> */
 export const waitFor = waiters.waitFor;
-/** ALIAS - waitEvery */
+/** <!-- DOCS-ALIAS: waiters.waitEvery  --> */
 export const waitEvery = waiters.waitEvery;
-/** ALIAS - stopInterval */
+/** <!-- DOCS-ALIAS: waiters.stopInterval  --> */
 export const stopInterval = waiters.stopInterval;
-/** ALIAS - interval */
+/** <!-- DOCS-ALIAS: waiters.interval  --> */
 export const interval = waiters.interval;

No alert changes

Improved metrics

Total package byte prevSize

566764

increased by10.63%

Lines of code

14605

increased by12.76%

Number of lines in readme file

2716

increased by0.37%

No dependency changes