@schukai/monster 3.80.2 → 3.80.4

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,13 +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
- * @deprecated since 3.15.0 use `BaseWithOptions` instead of `BaseWithOptions`
+ * @deprecated since 3.15.0
  */
 class BaseWithOptions extends Base {
 	/**
@@ -51,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/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 = [];