@schukai/monster 3.51.5 → 3.52.1

package/source/types/observer.mjs

@@ -15,8 +15,16 @@ export { Observer };
 /**
  * An observer manages a callback function
  *
- * The update method is called with the subject object as this pointer. For this reason the callback should not
- * be an arrow function, because it gets this pointer of its own context.
+ * The update method is called with the subject object as this pointer. For this reason 
+ * the callback should not be an arrow function, because it gets this pointer of its own context.
+ * 
+ * Include this class in your project with the following code:
+ * 
+ * ```js
+ * import { Observer } from "@schukai/monster/source/types/observer.mjs";
+ * ```
+ * 
+ * The callback function is passed as the first argument to the constructor.
  *
  * ```js
  * new Observer(()=>{
@@ -45,108 +53,108 @@ export { Observer };
  * @memberOf Monster.Types
  */
 class Observer extends Base {
-    /**
-     *
-     * @param {function} callback
-     * @param {*} args
-     */
-    constructor(callback, ...args) {
-        super();
-
-        if (typeof callback !== "function") {
-            throw new Error("observer callback must be a function");
-        }
-
-        this.callback = callback;
-        this.arguments = args;
-        this.tags = new TokenList();
-        this.queue = new UniqueQueue();
-    }
-
-    /**
-     * This method is called by the `instanceof` operator.
-     * @returns {symbol}
-     * @since 2.1.0
-     */
-    static get [instanceSymbol]() {
-        return Symbol.for("@schukai/monster/types/observer");
-    }
-
-    /**
-     *
-     * @param {string} tag
-     * @returns {Observer}
-     */
-    addTag(tag) {
-        this.tags.add(tag);
-        return this;
-    }
-
-    /**
-     *
-     * @param {string} tag
-     * @returns {Observer}
-     */
-    removeTag(tag) {
-        this.tags.remove(tag);
-        return this;
-    }
-
-    /**
-     *
-     * @returns {Array}
-     */
-    getTags() {
-        return this.tags.entries();
-    }
-
-    /**
-     *
-     * @param {string} tag
-     * @returns {boolean}
-     */
-    hasTag(tag) {
-        return this.tags.contains(tag);
-    }
-
-    /**
-     *
-     * @param {object} subject
-     * @returns {Promise}
-     */
-    update(subject) {
-        let self = this;
-
-        return new Promise(function (resolve, reject) {
-            if (!isObject(subject)) {
-                reject("subject must be an object");
-                return;
-            }
-
-            self.queue.add(subject);
-
-            setTimeout(() => {
-                try {
-                    // the queue and the settimeout ensure that an object is not
-                    // informed of the same change more than once.
-                    if (self.queue.isEmpty()) {
-                        resolve();
-                        return;
-                    }
-
-                    let s = self.queue.poll();
-                    let result = self.callback.apply(s, self.arguments);
-
-                    if (isObject(result) && result instanceof Promise) {
-                        result.then(resolve).catch(reject);
-                        return;
-                    }
-
-                    resolve(result);
-                } catch (e) {
-                    reject(e);
-                }
-            }, 0);
-        });
-    }
+	/**
+	 *
+	 * @param {function} callback
+	 * @param {*} args
+	 */
+	constructor(callback, ...args) {
+		super();
+
+		if (typeof callback !== "function") {
+			throw new Error("observer callback must be a function");
+		}
+
+		this.callback = callback;
+		this.arguments = args;
+		this.tags = new TokenList();
+		this.queue = new UniqueQueue();
+	}
+
+	/**
+	 * This method is called by the `instanceof` operator.
+	 * @returns {symbol}
+	 * @since 2.1.0
+	 */
+	static get [instanceSymbol]() {
+		return Symbol.for("@schukai/monster/types/observer");
+	}
+
+	/**
+	 *
+	 * @param {string} tag
+	 * @returns {Observer}
+	 */
+	addTag(tag) {
+		this.tags.add(tag);
+		return this;
+	}
+
+	/**
+	 *
+	 * @param {string} tag
+	 * @returns {Observer}
+	 */
+	removeTag(tag) {
+		this.tags.remove(tag);
+		return this;
+	}
+
+	/**
+	 *
+	 * @returns {Array}
+	 */
+	getTags() {
+		return this.tags.entries();
+	}
+
+	/**
+	 *
+	 * @param {string} tag
+	 * @returns {boolean}
+	 */
+	hasTag(tag) {
+		return this.tags.contains(tag);
+	}
+
+	/**
+	 *
+	 * @param {object} subject
+	 * @returns {Promise}
+	 */
+	update(subject) {
+		const self = this;
+
+		return new Promise(function (resolve, reject) {
+			if (!isObject(subject)) {
+				reject("subject must be an object");
+				return;
+			}
+
+			self.queue.add(subject);
+
+			setTimeout(() => {
+				try {
+					// the queue and the settimeout ensure that an object is not
+					// informed of the same change more than once.
+					if (self.queue.isEmpty()) {
+						resolve();
+						return;
+					}
+
+					const s = self.queue.poll();
+					const result = self.callback.apply(s, self.arguments);
+
+					if (isObject(result) && result instanceof Promise) {
+						result.then(resolve).catch(reject);
+						return;
+					}
+
+					resolve(result);
+				} catch (e) {
+					reject(e);
+				}
+			}, 0);
+		});
+	}
 }

package/source/types/observerlist.mjs

@@ -20,79 +20,79 @@ export { ObserverList };
  * @memberOf Monster.Types
  */
 class ObserverList extends Base {
-    /**
-     *
-     */
-    constructor() {
-        super();
-        this.observers = [];
-    }
+	/**
+	 *
+	 */
+	constructor() {
+		super();
+		this.observers = [];
+	}
 
-    /**
-     *
-     * @param {Observer} observer
-     * @return {ObserverList}
-     * @throws {TypeError} value is not an instance of Observer
-     */
-    attach(observer) {
-        validateInstance(observer, Observer);
+	/**
+	 *
+	 * @param {Observer} observer
+	 * @return {ObserverList}
+	 * @throws {TypeError} value is not an instance of Observer
+	 */
+	attach(observer) {
+		validateInstance(observer, Observer);
 
-        this.observers.push(observer);
-        return this;
-    }
+		this.observers.push(observer);
+		return this;
+	}
 
-    /**
-     *
-     * @param {Observer} observer
-     * @return {ObserverList}
-     * @throws {TypeError} value is not an instance of Observer
-     */
-    detach(observer) {
-        validateInstance(observer, Observer);
+	/**
+	 *
+	 * @param {Observer} observer
+	 * @return {ObserverList}
+	 * @throws {TypeError} value is not an instance of Observer
+	 */
+	detach(observer) {
+		validateInstance(observer, Observer);
 
-        var i = 0;
-        var l = this.observers.length;
-        for (; i < l; i++) {
-            if (this.observers[i] === observer) {
-                this.observers.splice(i, 1);
-            }
-        }
+		var i = 0;
+		var l = this.observers.length;
+		for (; i < l; i++) {
+			if (this.observers[i] === observer) {
+				this.observers.splice(i, 1);
+			}
+		}
 
-        return this;
-    }
+		return this;
+	}
 
-    /**
-     *
-     * @param {Observer} observer
-     * @return {boolean}
-     * @throws {TypeError} value is not an instance of Observer
-     */
-    contains(observer) {
-        validateInstance(observer, Observer);
-        var i = 0;
-        var l = this.observers.length;
-        for (; i < l; i++) {
-            if (this.observers[i] === observer) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 *
+	 * @param {Observer} observer
+	 * @return {boolean}
+	 * @throws {TypeError} value is not an instance of Observer
+	 */
+	contains(observer) {
+		validateInstance(observer, Observer);
+		var i = 0;
+		var l = this.observers.length;
+		for (; i < l; i++) {
+			if (this.observers[i] === observer) {
+				return true;
+			}
+		}
+		return false;
+	}
 
-    /**
-     *
-     * @param subject
-     * @return {Promise}
-     */
-    notify(subject) {
-        let pomises = [];
+	/**
+	 *
+	 * @param subject
+	 * @return {Promise}
+	 */
+	notify(subject) {
+		const pomises = [];
 
-        let i = 0;
-        let l = this.observers.length;
-        for (; i < l; i++) {
-            pomises.push(this.observers[i].update(subject));
-        }
+		let i = 0;
+		const l = this.observers.length;
+		for (; i < l; i++) {
+			pomises.push(this.observers[i].update(subject));
+		}
 
-        return Promise.all(pomises);
-    }
+		return Promise.all(pomises);
+	}
 }