@schukai/monster 3.80.2 → 3.80.3

package/source/types/is.mjs

@@ -34,11 +34,10 @@ export {
  *
  * @externalExample ../../example/types/is-1.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.2.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isIterable(value) {
 	if (value === undefined) return false;
@@ -53,11 +52,10 @@ function isIterable(value) {
  *
  * @externalExample ../../example/types/is-2.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isPrimitive(value) {
 	var type;
@@ -87,11 +85,10 @@ function isPrimitive(value) {
  *
  * @externalExample ../../example/types/is-3.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.9.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isSymbol(value) {
 	return "symbol" === typeof value ? true : false;
@@ -104,11 +101,10 @@ function isSymbol(value) {
  *
  * @externalExample ../../example/types/is-4.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isBoolean(value) {
 	if (value === true || value === false) {
@@ -125,11 +121,10 @@ function isBoolean(value) {
  *
  * @externalExample ../../example/types/is-5.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isString(value) {
 	if (value === undefined || typeof value !== "string") {
@@ -145,11 +140,10 @@ function isString(value) {
  *
  * @externalExample ../../example/types/is-6.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isObject(value) {
 	if (isArray(value)) return false;
@@ -170,11 +164,10 @@ function isObject(value) {
  * @externalExample ../../example/types/is-7.mjs
  * @param {*} value
  * @param {*} instance
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.5.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isInstance(value, instance) {
 	if (!isObject(value)) return false;
@@ -190,11 +183,10 @@ function isInstance(value, instance) {
  *
  * @externalExample ../../example/types/is-8.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  * @see https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
  */
 function isArray(value) {
@@ -208,11 +200,10 @@ function isArray(value) {
  *
  * @externalExample ../../example/types/is-9.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isFunction(value) {
 	if (isArray(value)) return false;
@@ -232,11 +223,10 @@ function isFunction(value) {
  *
  * @externalExample ../../example/types/is-10.mjs
  * @param {*} value
- * @returns {boolean}
+ * @return {boolean}
  * @license AGPLv3
  * @since 1.4.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 function isInteger(value) {
 	return Number.isInteger(value);

package/source/types/mediatype.mjs

@@ -62,7 +62,7 @@ class MediaType extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/types/node.mjs

@@ -59,7 +59,7 @@ class Node extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/types/nodelist.mjs

@@ -49,7 +49,7 @@ class NodeList extends Set {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -68,7 +68,7 @@ class NodeList extends Set {
 
 	/**
 	 * @param {Node} node
-	 * @returns {NodeList}
+	 * @return {NodeList}
 	 */
 	remove(node) {
 		super.delete(validateInstance(node, Node));
@@ -77,14 +77,14 @@ class NodeList extends Set {
 
 	/**
 	 * @param {Node} node
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	has(node) {
 		return super.has(validateInstance(node, Node));
 	}
 
 	/**
-	 * @returns {NodeList}
+	 * @return {NodeList}
 	 */
 	clear() {
 		super.clear();
@@ -92,21 +92,21 @@ class NodeList extends Set {
 	}
 
 	/**
-	 * @returns {NodeList}
+	 * @return {NodeList}
 	 */
 	toArray() {
 		return Array.from(this);
 	}
 
 	/**
-	 * @returns {NodeList}
+	 * @return {NodeList}
 	 */
 	toJSON() {
 		return this.toArray();
 	}
 
 	/**
-	 * @returns {NodeList}
+	 * @return {NodeList}
 	 */
 	toString() {
 		const parts = [];

package/source/types/observablequeue.mjs

@@ -40,7 +40,7 @@ class ObservableQueue extends Queue {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/types/observablequeue");
@@ -50,7 +50,7 @@ class ObservableQueue extends Queue {
 	 * Add a new element to the end of the queue.
 	 *
 	 * @param {*} value
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	add(value) {
 		super.add(value);
@@ -61,7 +61,7 @@ class ObservableQueue extends Queue {
 	/**
 	 * remove all entries
 	 *
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	clear() {
 		super.clear();
@@ -73,7 +73,7 @@ class ObservableQueue extends Queue {
 	 * Attach a new observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	attachObserver(observer) {
 		this[internalSymbol].observers.attach(observer);
@@ -84,7 +84,7 @@ class ObservableQueue extends Queue {
 	 * Detach a observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	detachObserver(observer) {
 		this[internalSymbol].observers.detach(observer);
@@ -94,7 +94,7 @@ class ObservableQueue extends Queue {
 	/**
 	 * Notify all observer
 	 *
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	notifyObservers() {
 		return this[internalSymbol].observers.notify(this);
@@ -102,7 +102,7 @@ class ObservableQueue extends Queue {
 
 	/**
 	 * @param {Observer} observer
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	containsObserver(observer) {
 		return this[internalSymbol].observers.contains(observer);

package/source/types/observer.mjs

@@ -77,7 +77,7 @@ class Observer extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -87,7 +87,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {string} tag
-	 * @returns {Observer}
+	 * @return {Observer}
 	 */
 	addTag(tag) {
 		this.tags.add(tag);
@@ -97,7 +97,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {string} tag
-	 * @returns {Observer}
+	 * @return {Observer}
 	 */
 	removeTag(tag) {
 		this.tags.remove(tag);
@@ -106,7 +106,7 @@ class Observer extends Base {
 
 	/**
 	 *
-	 * @returns {Array}
+	 * @return {Array}
 	 */
 	getTags() {
 		return this.tags.entries();
@@ -115,7 +115,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {string} tag
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	hasTag(tag) {
 		return this.tags.contains(tag);
@@ -124,7 +124,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {object} subject
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	update(subject) {
 		const self = this;

package/source/types/proxyobserver.mjs

@@ -57,7 +57,7 @@ class ProxyObserver extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -65,7 +65,7 @@ class ProxyObserver extends Base {
 	}
 
 	/**
-	 * @returns {object}
+	 * @return {object}
 	 */
 	getSubject() {
 		return this.subject;
@@ -93,7 +93,7 @@ class ProxyObserver extends Base {
 	 *
 	 * Changes to this object are not noticed by the observers, so you can make a large number of changes and inform the observers later.
 	 *
-	 * @returns {object}
+	 * @return {object}
 	 */
 	getRealSubject() {
 		return this.realSubject;
@@ -103,7 +103,7 @@ class ProxyObserver extends Base {
 	 * attach a new observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	attachObserver(observer) {
 		this.observers.attach(observer);
@@ -114,7 +114,7 @@ class ProxyObserver extends Base {
 	 * detach a observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	detachObserver(observer) {
 		this.observers.detach(observer);
@@ -124,7 +124,7 @@ class ProxyObserver extends Base {
 	/**
 	 * notify all observer
 	 *
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	notifyObservers() {
 		return this.observers.notify(this);
@@ -132,7 +132,7 @@ class ProxyObserver extends Base {
 
 	/**
 	 * @param {Observer} observer
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	containsObserver(observer) {
 		return this.observers.contains(observer);
@@ -141,7 +141,7 @@ class ProxyObserver extends Base {
 
 /**
  *
- * @returns {{defineProperty: (function(*=, *=, *=): *), setPrototypeOf: (function(*, *=): boolean), set: (function(*, *, *, *): boolean), get: ((function(*=, *=, *=): (undefined))|*), deleteProperty: ((function(*, *): (boolean))|*)}}
+ * @return {{defineProperty: (function(*=, *=, *=): *), setPrototypeOf: (function(*, *=): boolean), set: (function(*, *, *, *): boolean), get: ((function(*=, *=, *=): (undefined))|*), deleteProperty: ((function(*, *): (boolean))|*)}}
  * @private
  * @see {@link https://gitlab.schukai.com/-/snippets/49}
  */

package/source/types/queue.mjs

@@ -41,7 +41,7 @@ class Queue extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -72,7 +72,7 @@ class Queue extends Base {
 	 * Add a new element to the end of the queue.
 	 *
 	 * @param {*} value
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	add(value) {
 		this.data.push(value);
@@ -82,7 +82,7 @@ class Queue extends Base {
 	/**
 	 * remove all entries
 	 *
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	clear() {
 		this.data = [];

package/source/types/stack.mjs

@@ -34,7 +34,7 @@ class Stack extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -65,7 +65,7 @@ class Stack extends Base {
 	 * pushes an item onto the top of this stack.
 	 *
 	 * @param {*} value
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	push(value) {
 		this.data.push(value);
@@ -75,7 +75,7 @@ class Stack extends Base {
 	/**
 	 * remove all entries
 	 *
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	clear() {
 		this.data = [];

package/source/types/tokenlist.mjs

@@ -46,7 +46,7 @@ class TokenList extends Base {
 	/**
 	 * Iterator protocol
 	 *
-	 * @returns {Symbol.iterator}
+	 * @return {Symbol.iterator}
 	 */
 	getIterator() {
 		return this[Symbol.iterator]();
@@ -55,7 +55,7 @@ class TokenList extends Base {
 	/**
 	 * Iterator
 	 *
-	 * @returns {{next: ((function(): ({value: *, done: boolean}))|*)}}
+	 * @return {{next: ((function(): ({value: *, done: boolean}))|*)}}
 	 */
 	[Symbol.iterator]() {
 		// Use a new index for each iterator. This makes multiple
@@ -80,7 +80,7 @@ class TokenList extends Base {
 	 *
 	 * @externalExample ../../example/types/tokenlist-2.mjs
 	 * @param {array|string|iteratable} value
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	contains(value) {
 		if (isString(value)) {
@@ -111,7 +111,7 @@ class TokenList extends Base {
 	 *
 	 * @externalExample ../../example/types/tokenlist-3.mjs
 	 * @param {array|string|iteratable} value
-	 * @returns {TokenList}
+	 * @return {TokenList}
 	 * @throws {TypeError} unsupported value
 	 */
 	add(value) {
@@ -134,7 +134,7 @@ class TokenList extends Base {
 	/**
 	 * remove all tokens
 	 *
-	 * @returns {TokenList}
+	 * @return {TokenList}
 	 */
 	clear() {
 		this.tokens.clear();
@@ -146,7 +146,7 @@ class TokenList extends Base {
 	 *
 	 * @externalExample ../../example/types/tokenlist-4.mjs
 	 * @param {array|string|iteratable} value
-	 * @returns {TokenList}
+	 * @return {TokenList}
 	 * @throws {TypeError} unsupported value
 	 */
 	remove(value) {
@@ -174,7 +174,7 @@ class TokenList extends Base {
 	 *
 	 * @param {string} token
 	 * @param {string} newToken
-	 * @returns {TokenList}
+	 * @return {TokenList}
 	 */
 	replace(token, newToken) {
 		validateString(token);
@@ -199,7 +199,7 @@ class TokenList extends Base {
 	 *
 	 * @externalExample ../../example/types/tokenlist-5.mjs
 	 * @param {array|string|iteratable} value
-	 * @returns {boolean}
+	 * @return {boolean}
 	 * @throws {TypeError} unsupported value
 	 */
 	toggle(value) {
@@ -221,7 +221,7 @@ class TokenList extends Base {
 	/**
 	 * returns an array with all tokens
 	 *
-	 * @returns {array}
+	 * @return {array}
 	 */
 	entries() {
 		return Array.from(this.tokens);
@@ -231,7 +231,7 @@ class TokenList extends Base {
 	 * executes the provided function with each value of the set
 	 *
 	 * @param {function} callback
-	 * @returns {TokenList}
+	 * @return {TokenList}
 	 */
 	forEach(callback) {
 		validateFunction(callback);
@@ -242,7 +242,7 @@ class TokenList extends Base {
 	/**
 	 * returns the individual tokens separated by a blank character
 	 *
-	 * @returns {string}
+	 * @return {string}
 	 */
 	toString() {
 		return this.entries().join(" ");
@@ -252,7 +252,7 @@ class TokenList extends Base {
 /**
  * @private
  * @param token
- * @returns {toggleValue}
+ * @return {toggleValue}
  * @throws {Error} must be called with TokenList.call
  */
 function toggleValue(token) {

package/source/types/uniquequeue.mjs

@@ -41,7 +41,7 @@ class UniqueQueue extends Queue {
 	 * Add a new element to the end of the queue.
 	 *
 	 * @param {object} value
-	 * @returns {Queue}
+	 * @return {Queue}
 	 * @throws {TypeError} value is not a object
 	 */
 	add(value) {
@@ -58,7 +58,7 @@ class UniqueQueue extends Queue {
 	/**
 	 * remove all entries
 	 *
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	clear() {
 		super.clear();

package/source/types/version.mjs

@@ -82,7 +82,7 @@ class Version extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -91,7 +91,7 @@ class Version extends Base {
 
 	/**
 	 *
-	 * @returns {string}
+	 * @return {string}
 	 */
 	toString() {
 		return `${this.major}.${this.minor}.${this.patch}`;
@@ -102,7 +102,7 @@ class Version extends Base {
 	 * than the compared version
 	 *
 	 * @param {string|Version} version Version to compare
-	 * @returns {number}
+	 * @return {number}
 	 */
 	compareTo(version) {
 		if (version instanceof Version) {
@@ -144,7 +144,7 @@ let monsterVersion;
 /**
  * Version of monster
  *
- * @returns {Version}
+ * @return {Version}
  * @license AGPLv3
  * @since 1.0.0
  * @copyright schukai GmbH

package/source/util/clone.mjs

@@ -29,7 +29,7 @@ export { clone };
  * If an object has a method `getClone()`, this method is used to create the clone.
  *
  * @param {*} obj object to be cloned
- * @returns {*}
+ * @return {*}
  * @license AGPLv3
  * @since 1.0.0
  * @memberOf Monster.Util
@@ -106,7 +106,7 @@ function clone(obj) {
 /**
  *
  * @param {object} obj
- * @returns {object}
+ * @return {object}
  * @private
  */
 function cloneObject(obj) {

package/source/util/comparator.mjs

@@ -38,10 +38,9 @@ export { Comparator };
  *      }).equal({v: 2}, {v: 2});  // ↦ true
  * ```
  *
- * @externalExample ../../example/util/comparator.mjs
+ * @example /example/comparator/simple/ Simple example
  * @license AGPLv3
  * @since 1.3.0
- * @memberOf Monster.Util
  */
 class Comparator extends Base {
 	/**

package/source/util/deadmansswitch.mjs

@@ -21,13 +21,13 @@ import { validateFunction, validateInteger } from "../types/validate.mjs";
 export { DeadMansSwitch };
 
 /**
- * The dead man's switch allows to set a timer which can be reset again and again within a defined period of time.
+ * The dead man's switch allows setting a timer which can be reset again
+ * and again within a defined period of time.
  *
- * @externalExample ../../example/util/deadmansswitch.mjs
+ * @example /example/util/deadmansswitch/simple/ Simple example
  * @copyright schukai GmbH
  * @license AGPLv3
  * @since 1.29.0
- * @memberOf Monster.Util
  * @summary Class to be able to execute function chains
  */
 class DeadMansSwitch extends Base {
@@ -46,8 +46,10 @@ class DeadMansSwitch extends Base {
 	}
 
 	/**
-	 *
-	 * @param {Integer|undefined} [delay]
+	 * @param delay
+	 * @returns {DeadMansSwitch}
+	 * @throws {Error} has already run
+	 * @throws {Error} unsupported argument
 	 */
 	touch(delay) {
 		if (this[internalSymbol]["isAlreadyRun"] === true) {

package/source/util/freeze.mjs

@@ -22,7 +22,7 @@ export { deepFreeze };
  * @param {object} object object to be freeze
  * @license AGPLv3
  * @since 1.0.0
- * @returns {object}
+ * @return {object}
  * @memberOf Monster.Util
  * @copyright schukai GmbH
  * @throws {TypeError} value is not a object

package/source/util/processing.mjs

@@ -34,11 +34,11 @@ export { Processing };
  *
  * The result of `run()` is a promise.
  *
- * @externalExample ../../example/util/processing.mjs
+ * @example /examples/libraries/util/processing/simple/ A simple example
+ *
  * @copyright schukai GmbH
  * @license AGPLv3
  * @since 1.21.0
- * @memberOf Monster.Util
  * @summary Class to be able to execute function chains
  */
 class Processing extends Base {