@schukai/monster 3.80.2 → 3.80.4

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 {

package/source/util/runtime.mjs

@@ -64,7 +64,7 @@ const ENV_UNKNOWN = "unknown";
  *
  * @since 3.34.0
  * @memberOf Monster.Util
- * @returns {string} The detected runtime environment. Possible values are:
+ * @return {string} The detected runtime environment. Possible values are:
  */
 function detectRuntimeEnvironment() {
 	// AWS Lambda environment