@schukai/monster 3.80.2 → 3.80.3

package/source/i18n/locale.mjs

@@ -109,7 +109,7 @@ class Locale extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {
@@ -254,7 +254,7 @@ class Locale extends Base {
  * ```
  *
  * @param {string} locale
- * @returns {Locale}
+ * @return {Locale}
  * @license AGPLv3
  * @since 1.14.0
  * @copyright schukai GmbH

package/source/i18n/provider.mjs

@@ -46,7 +46,7 @@ const translationsLinkSymbol = Symbol.for(
 class Provider extends BaseWithOptions {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {

package/source/i18n/providers/embed.mjs

@@ -30,9 +30,7 @@ export { Embed };
  * @license AGPLv3
  * @since 1.13.0
  * @copyright schukai GmbH
- * @memberOf Monster.I18n.Providers
  * @see {@link https://datatracker.ietf.org/doc/html/rfc3066}
- * @tutorial i18n-locale-and-formatter
  */
 class Embed extends Provider {
 	/**
@@ -148,7 +146,7 @@ class Embed extends Provider {
 	 * `script[data-monster-role=translations]` is searched for and the translations are assigned to the element.
 	 *
 	 * @param element
-	 * @returns {Promise<Awaited<unknown>[]>}
+	 * @returns {Promise<Awaited<*[]>>|Promise<Awaited<unknown>[]>}
 	 */
 	static assignTranslationsToElement(element) {
 		const d = getDocument();

package/source/i18n/translations.mjs

@@ -56,7 +56,7 @@ class Translations extends Base {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 3.27.0
 	 */
 	static get [instanceSymbol]() {
@@ -214,7 +214,7 @@ class Translations extends Base {
  * Returns the translations for the current document.
  *
  * @param {HTMLElement|undefined} [element] - Element to search for translations. Default: element with objectlink @schukai/monster/i18n/translations@@link.
- * @returns {Translations}
+ * @return {Translations}
  * @throws {Error} Element is not an HTMLElement.
  * @throws {Error} Cannot find the element with translations. Add the translation object to the document.
  * @throws {Error} This element has no translations.

package/source/logging/handler/console.mjs

@@ -34,7 +34,7 @@ class ConsoleHandler extends Handler {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {LogEntry} entry
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	log(entry) {
 		if (super.log(entry)) {

package/source/logging/handler.mjs

@@ -45,7 +45,7 @@ class Handler extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {LogEntry} entry
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	log(entry) {
 		validateInstance(entry, LogEntry);
@@ -61,7 +61,7 @@ class Handler extends Base {
 	 * set loglevel
 	 *
 	 * @param {integer} loglevel
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setLogLevel(loglevel) {
@@ -73,7 +73,7 @@ class Handler extends Base {
 	/**
 	 * get loglevel
 	 *
-	 * @returns {integer}
+	 * @return {integer}
 	 * @since 1.5.0
 	 */
 	getLogLevel() {
@@ -83,7 +83,7 @@ class Handler extends Base {
 	/**
 	 *  Set log level to All
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setAll() {
@@ -94,7 +94,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Trace
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setTrace() {
@@ -105,7 +105,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Debug
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setDebug() {
@@ -116,7 +116,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Info
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setInfo() {
@@ -127,7 +127,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Warn
 	 *
-	 * @returns {undefined}
+	 * @return {undefined}
 	 * @since 1.5.0
 	 */
 	setWarn() {
@@ -138,7 +138,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Error
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setError() {
@@ -149,7 +149,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Fatal
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setFatal() {
@@ -160,7 +160,7 @@ class Handler extends Base {
 	/**
 	 * Set log level to Off
 	 *
-	 * @returns {Handler}
+	 * @return {Handler}
 	 * @since 1.5.0
 	 */
 	setOff() {

package/source/logging/logentry.mjs

@@ -41,7 +41,7 @@ class LogEntry extends Base {
 
 	/**
 	 *
-	 * @returns {integerr}
+	 * @return {integerr}
 	 */
 	getLogLevel() {
 		return this.loglevel;
@@ -49,7 +49,7 @@ class LogEntry extends Base {
 
 	/**
 	 *
-	 * @returns {array}
+	 * @return {array}
 	 */
 	getArguments() {
 		return this.arguments;

package/source/logging/logger.mjs

@@ -84,7 +84,7 @@ class Logger extends Base {
 	/**
 	 *
 	 * @param {Handler} handler
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @throws {Error} the handler must be an instance of Handler
 	 */
 	addHandler(handler) {
@@ -100,7 +100,7 @@ class Logger extends Base {
 	/**
 	 *
 	 * @param {Handler} handler
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @throws {Error} the handler must be an instance of Handler
 	 */
 	removeHandler(handler) {
@@ -119,7 +119,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logTrace(...args) {
@@ -137,7 +137,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logDebug(...args) {
@@ -156,7 +156,7 @@ class Logger extends Base {
 	 *
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logInfo(...args) {
@@ -174,7 +174,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logWarn(...args) {
@@ -192,7 +192,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logError(...args) {
@@ -210,7 +210,7 @@ class Logger extends Base {
 	 * ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF  (ALL = 0xff;OFF = 0x00;
 	 *
 	 * @param {*} arguments
-	 * @returns {Logger}
+	 * @return {Logger}
 	 * @since 1.5.0
 	 */
 	logFatal(...args) {
@@ -226,7 +226,7 @@ class Logger extends Base {
 	 * Labels
 	 *
 	 * @param {integer} level
-	 * @returns {string}
+	 * @return {string}
 	 */
 	getLabel(level) {
 		validateInteger(level);
@@ -247,7 +247,7 @@ class Logger extends Base {
 	 * Level
 	 *
 	 * @param {string} label
-	 * @returns {integer}
+	 * @return {integer}
 	 */
 	getLevel(label) {
 		validateString(label);
@@ -270,7 +270,7 @@ class Logger extends Base {
  *
  * @param {integer} loglevel
  * @param {*} args
- * @returns {Logger}
+ * @return {Logger}
  * @private
  */
 function triggerLog(loglevel, ...args) {

package/source/math/random.mjs

@@ -21,7 +21,7 @@ export { random };
  *
  * @param {number} min starting value of the definition set (default is 0)
  * @param {number} max end value of the definition set (default is 1000000000)
- * @returns {number}
+ * @return {number}
  * @memberOf Monster.Math
  * @throws {Error} missing crypt
  * @throws {Error} we cannot generate numbers larger than 53 bits.
@@ -62,7 +62,7 @@ Math.log2 =
  *
  * @param {number} min
  * @param {number} max
- * @returns {number}
+ * @return {number}
  * @private
  * @throws {Error} missing crypt
  * @throws {Error} we cannot generate numbers larger than 53 bits.

package/source/monster.mjs

@@ -106,6 +106,7 @@ export * from "./util/deadmansswitch.mjs";
 export * from "./util/comparator.mjs";
 export * from "./util/freeze.mjs";
 export * from "./util/clone.mjs";
+export * from "./util/processing/callback.mjs";
 export * from "./logging/handler/console.mjs";
 export * from "./logging/logger.mjs";
 export * from "./logging/handler.mjs";

package/source/net/webconnect/message.mjs

@@ -40,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];
@@ -55,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,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);