@schukai/monster 1.15.5 → 1.17.1

package/source/types/validate.js

@@ -25,7 +25,7 @@ import {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateIterable('2')) // ↦ TypeError
  * console.log(Monster.Types.validateIterable([])) // ↦ value
  * </script>
@@ -35,7 +35,7 @@ import {
  *
  * ```
  * <script type="module">
- * import {validateIterable} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateIterable} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateIterable('2'))  // ↦ TypeError
  * console.log(validateIterable([]))  // ↦ value
  * </script>
@@ -45,11 +45,11 @@ import {
  * @return {*}
  * @since 1.2.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not a primitive
  * @see {@link isPrimitive}
- * @see {@link Monster/Types/isPrimitive}
- * @see {@link Monster/Types#isPrimitive}
+ * @see {@link Monster.Types.isPrimitive}
+ * @see {@link Monster.Types#isPrimitive}
  */
 function validateIterable(value) {
     if (!isIterable(value)) {
@@ -65,7 +65,7 @@ function validateIterable(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validatePrimitive('2')) // ↦ value
  * console.log(Monster.Types.validatePrimitive([])) // ↦ TypeError
  * </script>
@@ -75,7 +75,7 @@ function validateIterable(value) {
  *
  * ```
  * <script type="module">
- * import {validatePrimitive} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validatePrimitive} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validatePrimitive('2'))  // ↦ value
  * console.log(validatePrimitive([]))  // ↦ TypeError
  * </script>
@@ -85,11 +85,11 @@ function validateIterable(value) {
  * @return {*}
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not a primitive
  * @see {@link isPrimitive}
- * @see {@link Monster/Types/isPrimitive}
- * @see {@link Monster/Types#isPrimitive}
+ * @see {@link Monster.Types.isPrimitive}
+ * @see {@link Monster.Types#isPrimitive}
  */
 function validatePrimitive(value) {
     if (!isPrimitive(value)) {
@@ -105,7 +105,7 @@ function validatePrimitive(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateBoolean(true)) // ↦ value
  * console.log(Monster.Types.validateBoolean('2')) // ↦ TypeError
  * console.log(Monster.Types.validateBoolean([])) // ↦ TypeError
@@ -116,7 +116,7 @@ function validatePrimitive(value) {
  *
  * ```
  * <script type="module">
- * import {validateBoolean} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateBoolean} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateBoolean(false))  // ↦ value
  * console.log(validateBoolean('2'))  // ↦ TypeError
  * console.log(validateBoolean([]))  // ↦ TypeError
@@ -127,7 +127,7 @@ function validatePrimitive(value) {
  * @return {*}
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
 
  * @throws {TypeError}  value is not primitive
  */
@@ -145,7 +145,7 @@ function validateBoolean(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateString('2')) // ↦ value
  * console.log(Monster.Types.validateString([])) // ↦ TypeError
  * </script>
@@ -155,7 +155,7 @@ function validateBoolean(value) {
  *
  * ```
  * <script type="module">
- * import {validateString} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateString} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateString('2'))  // ↦ value
  * console.log(validateString([]))  // ↦ TypeError
  * </script>
@@ -165,7 +165,7 @@ function validateBoolean(value) {
  * @return {*}
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not a string
  */
 function validateString(value) {
@@ -183,7 +183,7 @@ function validateString(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateObject({})) // ↦ value
  * console.log(Monster.Types.validateObject('2')) // ↦ TypeError
  * console.log(Monster.Types.validateObject([])) // ↦ TypeError
@@ -194,7 +194,7 @@ function validateString(value) {
  *
  * ```
  * <script type="module">
- * import {validateObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateObject} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateObject({}))  // ↦ value
  * console.log(validateObject('2'))  // ↦ TypeError
  * console.log(validateObject([]))  // ↦ TypeError
@@ -205,7 +205,7 @@ function validateString(value) {
  * @return {*}
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not a object
  */
 function validateObject(value) {
@@ -222,7 +222,7 @@ function validateObject(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateInstance({}, Object)) // ↦ value
  * console.log(Monster.Types.validateInstance('2', Object)) // ↦ TypeError
  * console.log(Monster.Types.validateInstance([], Object)) // ↦ TypeError
@@ -233,7 +233,7 @@ function validateObject(value) {
  *
  * ```
  * <script type="module">
- * import {validateInstance} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateInstance} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateInstance({}, Object)) // ↦ value
  * console.log(validateInstance('2', Object)) // ↦ TypeError
  * console.log(validateInstance([], Object)) // ↦ TypeError
@@ -244,7 +244,7 @@ function validateObject(value) {
  * @return {*}
  * @since 1.5.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not an instance of
  */
 function validateInstance(value, instance) {
@@ -270,7 +270,7 @@ function validateInstance(value, instance) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateArray('2')) // ↦ TypeError
  * console.log(Monster.Types.validateArray([])) // ↦ value
  * </script>
@@ -280,7 +280,7 @@ function validateInstance(value, instance) {
  *
  * ```
  * <script type="module">
- * import {validateArray} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateArray} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateArray('2'))  // ↦ TypeError
  * console.log(validateArray([]))  // ↦ value
  * </script>
@@ -290,7 +290,7 @@ function validateInstance(value, instance) {
  * @return {*}
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not an array
  */
 function validateArray(value) {
@@ -307,7 +307,7 @@ function validateArray(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateSymbol('2')) // ↦ TypeError
  * console.log(Monster.Types.validateSymbol([])) // ↦ value
  * </script>
@@ -317,7 +317,7 @@ function validateArray(value) {
  *
  * ```
  * <script type="module">
- * import {validateSymbol} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateSymbol} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateSymbol('2'))  // ↦ TypeError
  * console.log(validateSymbol())  // ↦ value
  * </script>
@@ -327,7 +327,7 @@ function validateArray(value) {
  * @return {*}
  * @since 1.9.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not an symbol
  */
 function validateSymbol(value) {
@@ -344,7 +344,7 @@ function validateSymbol(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateFunction(()=>{})) // ↦ value
  * console.log(Monster.Types.validateFunction('2')) // ↦ TypeError
  * console.log(Monster.Types.validateFunction([])) // ↦ TypeError
@@ -355,7 +355,7 @@ function validateSymbol(value) {
  *
  * ```
  * <script type="module">
- * import {validateFunction} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateFunction} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateFunction(()=>{})) // ↦ value
  * console.log(validateFunction('2'))  // ↦ TypeError
  * console.log(validateFunction([]))  // ↦ TypeError
@@ -366,7 +366,7 @@ function validateSymbol(value) {
  * @return {*}
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not a function
  */
 function validateFunction(value) {
@@ -383,7 +383,7 @@ function validateFunction(value) {
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(Monster.Types.validateInteger(true)) // ↦ TypeError
  * console.log(Monster.Types.validateInteger('2')) // ↦ TypeError
  * console.log(Monster.Types.validateInteger(2)) // ↦ value
@@ -394,7 +394,7 @@ function validateFunction(value) {
  *
  * ```
  * <script type="module">
- * import {validateFunction} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/validate.js';
+ * import {validateFunction} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/validate.js';
  * console.log(validateInteger(true)) // ↦ TypeError
  * console.log(validateInteger('2'))  // ↦ TypeError
  * console.log(validateInteger(2))  // ↦ value
@@ -405,7 +405,7 @@ function validateFunction(value) {
  * @return {*}
  * @since 1.4.0
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  * @throws {TypeError} value is not an integer
  */
 function validateInteger(value) {

package/source/types/version.js

@@ -10,7 +10,7 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/version.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/version.js';
  * console.log(new Monster.Types.Version('1.2.3')) // ↦ 1.2.3
  * console.log(new Monster.Types.Version('1')) // ↦ 1.0.0
  * </script>
@@ -20,7 +20,7 @@ import {Base} from './base.js';
  *
  * ```
  * <script type="module">
- * import {Version} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/version.js';
+ * import {Version} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/version.js';
  * console.log(new Version('1.2.3')) // ↦ 1.2.3
  * console.log(new Version('1')) // ↦ 1.0.0
  * </script>
@@ -28,7 +28,7 @@ import {Base} from './base.js';
  *
  * @example
  *
- * import {Version} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/version.js';
+ * import {Version} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/version.js';
  *
  * new Version('1.0.0') // ↦ 1.0.0
  * new Version(1)  // ↦ 1.0.0
@@ -38,7 +38,7 @@ import {Base} from './base.js';
  * @since 1.0.0
  * @author schukai GmbH
  * @copyright schukai GmbH
- * @memberOf Monster/Types
+ * @memberOf Monster.Types
  */
 class Version extends Base {
 
@@ -150,7 +150,7 @@ let monsterVersion;
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/version.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/version.js';
  * console.log(Monster.getVersion())
  * </script>
  * ```
@@ -159,7 +159,7 @@ let monsterVersion;
  *
  * ```
  * <script type="module">
- * import {getVersion} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/types/version.js';
+ * import {getVersion} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/types/version.js';
  * console.log(getVersion())
  * </script>
  * ```
@@ -175,7 +175,7 @@ function getVersion() {
         return monsterVersion;
     }
     /**#@+ dont touch, replaced by make with package.json version */
-    monsterVersion = new Version('1.15.5')
+    monsterVersion = new Version('1.17.1')
     /**#@-*/
 
     return monsterVersion;

package/source/util/clone.js

@@ -22,7 +22,7 @@ import {isArray, isFunction, isObject, isPrimitive} from '../types/is.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/clone.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/clone.js';
  * console.log(Monster.Util.clone({}))
  * </script>
  * ```
@@ -31,7 +31,7 @@ import {isArray, isFunction, isObject, isPrimitive} from '../types/is.js';
  *
  * ```
  * <script type="module">
- * import {clone} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/clone.js';
+ * import {clone} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/clone.js';
  * console.log(clone({}))
  * </script>
  * ```
@@ -40,7 +40,7 @@ import {isArray, isFunction, isObject, isPrimitive} from '../types/is.js';
  * @returns {*}
  *
  * @since 1.0.0
- * @memberOf Monster/Util
+ * @memberOf Monster.Util
  * @copyright schukai GmbH
  * @throws {Error} unable to clone obj! its type isn't supported.
  */

package/source/util/comparator.js

@@ -12,7 +12,7 @@ import {isFunction} from '../types/is.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/comparator.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/comparator.js';
  * console.log(new Monster.Util.Comparator())
  * </script>
  * ```
@@ -21,7 +21,7 @@ import {isFunction} from '../types/is.js';
  *
  * ```
  * <script type="module">
- * import {Comparator} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/comparator.js';
+ * import {Comparator} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/comparator.js';
  * console.log(new Comparator())
  * </script>
  * ```
@@ -46,7 +46,7 @@ import {isFunction} from '../types/is.js';
  *
  * @example
  *
- * import {Comparator} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/comparator.js';
+ * import {Comparator} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/comparator.js';
  *
  * console.log(new Comparator().lessThanOrEqual(2, 5))
  * // ↦ true
@@ -58,16 +58,16 @@ import {isFunction} from '../types/is.js';
  * // ↦ false
  *
  * @since 1.3.0
- * @memberOf Monster/Util
+ * @memberOf Monster.Util
  */
 class Comparator extends Base {
 
     /**
      * create new comparator
      *
-     * @param {function} callback
-     * @throw {TypeError} "unsupported type"
-     * @throw {TypeError} "impractical comparison"
+     * @param {Monster.Util~exampleCallback} [callback] Comparator callback
+     * @throw {TypeError} unsupported type
+     * @throw {TypeError} impractical comparison
      */
     constructor(callback) {
         super();
@@ -78,6 +78,13 @@ class Comparator extends Base {
             throw new TypeError("unsupported type")
         } else {
             // default compare function
+
+            /**
+             *
+             * @param {*} a
+             * @param {*} b
+             * @return {integer} -1, 0 or 1
+             */
             this.compare = function (a, b) {
 
                 if (typeof a !== typeof b) {
@@ -168,5 +175,28 @@ class Comparator extends Base {
 
 }
 
+
+/**
+ * This is the description for the callback function used by the operator
+ *
+ * ```
+ * new Comparator(function (a, b) {
+ *      if (a.v === b.v) return 0;
+ *         return a.v < b.v ? -1 : 1;
+ *      }).equal({v: 2}, {v: 2});  // ↦ true
+ * ```
+ *
+ * @callback Monster.Util~exampleCallback
+ * @param {*} a
+ * @param {*} b
+ * @return {integer} -1, 0 or 1
+ * @memberOf Monster.Util
+ * @see Monster.Util.Comparator
+ */
+
+
+/**
+ *
+ */
 assignToNamespace('Monster.Util', Comparator);
 export {Monster, Comparator}

package/source/util/freeze.js

@@ -14,7 +14,7 @@ import {validateObject} from '../types/validate.js';
  *
  * ```
  * <script type="module">
- * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/freeze.js';
+ * import {Monster} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/freeze.js';
  * console.log(Monster.Util.deepFreeze({}))
  * </script>
  * ```
@@ -23,15 +23,15 @@ import {validateObject} from '../types/validate.js';
  *
  * ```
  * <script type="module">
- * import {deepFreeze} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.15.5/dist/modules/util/freeze.js';
+ * import {deepFreeze} from 'https://cdn.jsdelivr.net/npm/@schukai/monster@1.17.1/dist/modules/util/freeze.js';
  * console.log(deepFreeze({}))
  * </script>
  * ```
  *
- * @param {object} obj object to be freeze
+ * @param {object} object object to be freeze
  * @since 1.0.0
  * @returns {object}
- * @memberOf Monster/Util
+ * @memberOf Monster.Util
  * @copyright schukai GmbH
  * @throws {TypeError} value is not a object
  */

package/source/util/namespace.js

@@ -3,7 +3,8 @@
 /**
  * Namespace for utilities.
  *
- * @namespace Monster/Util
+ * @namespace Monster.Util
+ * @memberOf Monster
  * @author schukai GmbH
  */
 
@@ -12,4 +13,4 @@
  * @private
  * @type {string}
  */
-const namespace = "Monster.Util";
+export const namespace = "Monster.Util";