@schukai/monster 3.80.1 → 3.80.3

package/source/net/webconnect/message.mjs

@@ -25,7 +25,6 @@ const dataSymbol = Symbol("@@data");
  * @license AGPLv3
  * @since 3.4.0
  * @copyright schukai GmbH
- * @memberOf Monster.Net.WebSocket
  * @summary The Message class encapsulates a WebSocket message.
  */
 class Message extends Base {
@@ -41,14 +40,14 @@ class Message extends Base {
 	/**
 	 * Returns the raw message.
 	 *
-	 * @returns {object}
+	 * @return {object}
 	 */
 	getData() {
 		return this[dataSymbol];
 	}
 
 	/**
-	 * @returns {*}
+	 * @return {*}
 	 */
 	toJSON() {
 		return this[dataSymbol];
@@ -56,7 +55,7 @@ class Message extends Base {
 
 	/**
 	 * @param {string} json
-	 * @returns {Message}
+	 * @return {Message}
 	 * @throws {TypeError} value is not a string
 	 */
 	static fromJSON(json) {

package/source/net/webconnect.mjs

@@ -209,7 +209,7 @@ class WebConnect extends BaseWithOptions {
 
 	/**
 	 *
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	connect() {
 		return new Promise((resolve, reject) => {
@@ -218,7 +218,7 @@ class WebConnect extends BaseWithOptions {
 	}
 
 	/**
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	isConnected() {
 		return this[connectionSymbol]?.socket?.readyState === 1;
@@ -226,7 +226,7 @@ class WebConnect extends BaseWithOptions {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/net/webconnect");
@@ -259,7 +259,7 @@ class WebConnect extends BaseWithOptions {
 	 *
 	 * @param {Number} [code=1000] The close code.
 	 * @param {String} [reason=""] The close reason.
-	 * @returns {Promise}
+	 * @return {Promise}
 	 * @see https://www.rfc-editor.org/rfc/rfc6455.html#section-7.4.1
 	 */
 	close(statusCode, reason) {
@@ -286,7 +286,7 @@ class WebConnect extends BaseWithOptions {
 	/**
 	 * Polls the receive queue for new messages.
 	 *
-	 * @returns {Message}
+	 * @return {Message}
 	 */
 	poll() {
 		return this[receiveQueueSymbol].poll();
@@ -295,7 +295,7 @@ class WebConnect extends BaseWithOptions {
 	/**
 	 * Are there any messages in the receive queue?
 	 *
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	dataReceived() {
 		return !this[receiveQueueSymbol].isEmpty();
@@ -304,7 +304,7 @@ class WebConnect extends BaseWithOptions {
 	/**
 	 * Get Message from the receive queue, but do not remove it.
 	 *
-	 * @returns {Object}
+	 * @return {Object}
 	 */
 	peek() {
 		return this[receiveQueueSymbol].peek();
@@ -314,7 +314,7 @@ class WebConnect extends BaseWithOptions {
 	 * Attach a new observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	attachObserver(observer) {
 		this[receiveQueueSymbol].attachObserver(observer);
@@ -325,7 +325,7 @@ class WebConnect extends BaseWithOptions {
 	 * Detach a observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	detachObserver(observer) {
 		this[receiveQueueSymbol].detachObserver(observer);
@@ -334,7 +334,7 @@ class WebConnect extends BaseWithOptions {
 
 	/**
 	 * @param {Observer} observer
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	containsObserver(observer) {
 		return this[receiveQueueSymbol].containsObserver(observer);

package/source/text/bracketed-key-value-hash.mjs

@@ -48,7 +48,7 @@ export { parseBracketedKeyValueHash, createBracketedKeyValueHash };
  *
  * @since 3.37.0
  * @param {string} hashString - The string to parse, containing bracketed key-value pairs.
- * @returns {Object} - An object representing the parsed result, with keys representing the selectors and values representing the key-value pairs associated with each selector.
+ * @return {Object} - An object representing the parsed result, with keys representing the selectors and values representing the key-value pairs associated with each selector.
  *                    - Returns an empty object if there was an error during parsing. */
 function parseBracketedKeyValueHash(hashString) {
 	const selectors = {};
@@ -207,7 +207,7 @@ function parseBracketedKeyValueHash(hashString) {
  *
  * @param {Object} object - The object containing selectors and key-value pairs.
  * @param {boolean} addHashPrefix - Whether to add the hash prefix # to the beginning of the string.
- * @returns {string} The hash selector string.
+ * @return {string} The hash selector string.
  * @since 3.37.0
  */
 function createBracketedKeyValueHash(object, addHashPrefix = true) {

package/source/text/generate-range-comparison-expression.mjs

@@ -58,7 +58,7 @@ export { generateRangeComparisonExpression };
  * @param {string} [options.eqOp='=='] - The comparison operator for equality to use.
  * @param {string} [options.geOp='>='] - The comparison operator for greater than or equal to to use.
  * @param {string} [options.leOp='<='] - The comparison operator for less than or equal to to use.
- * @returns {string} The generated comparison expression.
+ * @return {string} The generated comparison expression.
  * @throws {Error} If the input is invalid.
  * @memberOf Monster.Text
  * @summary Generates a comparison expression based on a range of values.

package/source/types/base.mjs

@@ -43,7 +43,7 @@ export { Base };
  */
 class Base extends Object {
 	/**
-	 * @returns {string}
+	 * @return {string}
 	 */
 	toString() {
 		return JSON.stringify(this);
@@ -51,7 +51,7 @@ class Base extends Object {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -61,7 +61,7 @@ class Base extends Object {
 	/**
 	 * This method is called by the `instanceof` operator.
 	 * @param that
-	 * @returns {boolean}
+	 * @return {boolean}
 	 * @since 2.1.0
 	 */
 	static [Symbol.hasInstance](that) {
@@ -96,7 +96,7 @@ class Base extends Object {
  *
  * @private
  * @param obj
- * @returns {boolean|any|boolean}
+ * @return {boolean|any|boolean}
  * @since 2.1.0
  */
 function checkInstanceSymbol(obj) {

package/source/types/basewithoptions.mjs

@@ -26,14 +26,12 @@ export { BaseWithOptions };
  * This class is actually only used as a base class.
  *
  * Classes that require the possibility of options can be derived directly from this class.
- * Derived classes almost always override the `defaul` getter with their own values.
+ * Derived classes almost always override the `default` getter with their own values.
  *
- * @externalExample ../../example/types/basewithoptions.mjs
  * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
- * @deprecated since 3.15.0 use {@link Monster.Types.Base} with {@link Monster.Types.equipWithInternal} instead.
+ * @deprecated since 3.15.0
  */
 class BaseWithOptions extends Base {
 	/**
@@ -52,7 +50,7 @@ class BaseWithOptions extends Base {
 
 	/**
 	 * This getter provides the options. Derived classes overwrite
-	 * this getter with their own values. It is good karma to always include
+	 * this getter with their own values. It is a good karma to always include
 	 * the values from the parent class.
 	 *
 	 * ```javascript

package/source/types/dataurl.mjs

@@ -30,12 +30,11 @@ export { DataUrl, parseDataURL };
 const internal = Symbol("internal");
 
 /**
- * You can create an object via the monster namespace `new Monster.Types.DataUrl()`.
+ * You can create an object via the monster namespace `new DataUrl()`.
  *
  * @license AGPLv3
  * @since 1.8.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
  * @see https://datatracker.ietf.org/doc/html/rfc2397
  */
@@ -43,7 +42,7 @@ class DataUrl extends Base {
 	/**
 	 *
 	 * @param {String} content
-	 * @param {String|Monster.Types.MediaType} mediatype
+	 * @param {String|MediaType} mediatype
 	 * @param {boolean} base64=true
 	 */
 	constructor(content, mediatype, base64) {
@@ -62,7 +61,7 @@ class DataUrl extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -98,7 +97,7 @@ class DataUrl extends Base {
 }
 
 /**
- * You can call the function via the monster namespace `Monster.Types.parseDataURL()`.
+ * You can call the function via the monster namespace `parseDataURL()`.
  *
  * Specification:
  *
@@ -109,13 +108,12 @@ class DataUrl extends Base {
  * parameter  := attribute "=" value
  * ```
  *
- * @param {String} dataurl
- * @return {Monster.Types.DataUrl}
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
  * @see https://datatracker.ietf.org/doc/html/rfc2397
  * @throws {TypeError} incorrect or missing data protocol
  * @throws {TypeError} malformed data url
- * @memberOf Monster.Types
+ * @param {string} dataurl
+ * @return {DataUrl}
  */
 function parseDataURL(dataurl) {
 	validateString(dataurl);

package/source/types/global.mjs

@@ -74,7 +74,7 @@ let globalReference;
  * @license AGPLv3
  * @since 1.6.0
  * @memberOf Monster.Types
- * @returns {object} globalThis
+ * @return {object} globalThis
  */
 function getGlobal() {
 	return globalReference;
@@ -107,7 +107,7 @@ function getGlobal() {
  * @since 1.6.0
  * @memberOf Monster.Types
  * @param {string} name
- * @returns {object}
+ * @return {object}
  * @throws {Error} the object is not defined
  * @throws {TypeError} value is not a object
  * @throws {TypeError} value is not a string

package/source/types/internal.mjs

@@ -63,7 +63,7 @@ function equipWithInternal() {
 	 * Attach a new observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	this["attachInternalObserver"] = (observer) => {
 		this[internalSymbol].attachObserver(observer);
@@ -74,7 +74,7 @@ function equipWithInternal() {
 	 * Detach a observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	this["detachInternalObserver"] = (observer) => {
 		this[internalSymbol].detachObserver(observer);
@@ -85,7 +85,7 @@ function equipWithInternal() {
 	 * Check if a observer is attached
 	 *
 	 * @param {Observer} observer
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	this["containsInternalObserver"] = (observer) => {
 		return this[internalSymbol].containsObserver(observer);

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/noderecursiveiterator.mjs

@@ -31,11 +31,7 @@ const isNodeListSymbol = Symbol("isNodeList");
 /**
  * Represents a recursive iterator for traversing nodes in a DOM tree.
  *
- * @externalExample ../../example/types/noderecursiveiterator.mjs
- * @license AGPLv3
  * @since 1.26.0
- * @copyright schukai GmbH
- * @memberOf Monster.Types
  * @summary An iterator to run recursively through a tree of nodes
  * @extends Base
  */
@@ -91,7 +87,7 @@ class NodeRecursiveIterator extends Base {
 
 	/**
 	 * @param {function} callback
-	 * @return {Monster.Types.NodeRecursiveIterator}
+	 * @return {NodeRecursiveIterator}
 	 */
 	forEach(callback) {
 		for (const node of this) {

package/source/types/observablequeue.mjs

@@ -23,11 +23,8 @@ export { ObservableQueue };
  *
  * `Queue.add()` and `Queue.clear()` notify all observers.
  *
- * @externalExample ../../example/types/queue.mjs
- * @license AGPLv3
  * @since 3.3.0
  * @copyright schukai GmbH
- * @memberOf Monster.Types
  * @summary An observable Queue (Fifo)
  */
 class ObservableQueue extends Queue {
@@ -43,8 +40,7 @@ class ObservableQueue extends Queue {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
-	 * @since 2.1.0
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/types/observablequeue");
@@ -54,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);
@@ -65,7 +61,7 @@ class ObservableQueue extends Queue {
 	/**
 	 * remove all entries
 	 *
-	 * @returns {Queue}
+	 * @return {Queue}
 	 */
 	clear() {
 		super.clear();
@@ -77,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);
@@ -88,7 +84,7 @@ class ObservableQueue extends Queue {
 	 * Detach a observer
 	 *
 	 * @param {Observer} observer
-	 * @returns {ProxyObserver}
+	 * @return {ProxyObserver}
 	 */
 	detachObserver(observer) {
 		this[internalSymbol].observers.detach(observer);
@@ -98,7 +94,7 @@ class ObservableQueue extends Queue {
 	/**
 	 * Notify all observer
 	 *
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	notifyObservers() {
 		return this[internalSymbol].observers.notify(this);
@@ -106,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

@@ -53,11 +53,8 @@ export { Observer };
  *
  * The callback function must have as many parameters as arguments are given.
  *
- * @externalExample ../../example/types/observer.mjs
  * @license AGPLv3
  * @since 1.0.0
- * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 class Observer extends Base {
 	/**
@@ -80,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]() {
@@ -90,7 +87,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {string} tag
-	 * @returns {Observer}
+	 * @return {Observer}
 	 */
 	addTag(tag) {
 		this.tags.add(tag);
@@ -100,7 +97,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {string} tag
-	 * @returns {Observer}
+	 * @return {Observer}
 	 */
 	removeTag(tag) {
 		this.tags.remove(tag);
@@ -109,7 +106,7 @@ class Observer extends Base {
 
 	/**
 	 *
-	 * @returns {Array}
+	 * @return {Array}
 	 */
 	getTags() {
 		return this.tags.entries();
@@ -118,7 +115,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {string} tag
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	hasTag(tag) {
 		return this.tags.contains(tag);
@@ -127,7 +124,7 @@ class Observer extends Base {
 	/**
 	 *
 	 * @param {object} subject
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	update(subject) {
 		const self = this;

package/source/types/observerlist.mjs

@@ -23,8 +23,6 @@ export { ObserverList };
  *
  * @license AGPLv3
  * @since 1.0.0
- * @copyright schukai GmbH
- * @memberOf Monster.Types
  */
 class ObserverList extends Base {
 	/**