@byloth/core 2.1.5 → 2.1.7

package/dist/core.esm.js

@@ -900,7 +900,7 @@ class u {
    *
    * for (const value of iterator)
    * {
-   *     if (value > 5) { break; } // Closing the iterator...
+   *     if (value > 5) { break; } // "Closing the iterator..."
    *
    *     console.log(value); // 1, 2, 3, 4, 5
    * }
@@ -2824,7 +2824,7 @@ class d {
    *
    * for await (const value of iterator)
    * {
-   *     if (value > 5) { break; } // Closing the iterator...
+   *     if (value > 5) { break; } // "Closing the iterator..."
    *
    *     console.log(value); // 1, 2, 3, 4, 5
    * }
@@ -3680,83 +3680,35 @@ const F = class F {
    * const publisher = new Publisher();
    * const context = publisher.createScope();
    *
-   * publisher.subscribe("player:death", () => { console.log(`Player has died.`); });
-   * context.subscribe("player:spawn", () => { console.log(`Player has spawned.`); });
+   * publisher.subscribe("player:death", () => console.log(`Player has died.`));
+   * context.subscribe("player:spawn", () => console.log(`Player has spawned.`));
    *
-   * publisher.publish("player:spawn"); // Player has spawned.
+   * publisher.publish("player:spawn"); // "Player has spawned."
    * context.publish("player:death"); // * no output *
    * ```
    *
    * ---
    *
    * @template U
-   * A map containing the names of the emittable events and the
-   * related callback signatures that can be subscribed to them.
-   * Default is `T`.
-   *
-   * @template X An utility type that extends the `U` map with a wildcard event.
+   * A map containing the additional names of the emittable events and
+   * the related callback signatures that can be subscribed to them.
+   * Default is `{ }`.
    *
    * @return
    * A new instance of the {@link Publisher} class that can be
    * used to publish and subscribe events within a specific context.
    */
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   createScope() {
-    const n = new F(), e = (t, ...s) => {
-      n.publish(t, ...s);
-    };
-    return this.subscribe("__internals__:clear", () => n.clear()), this.subscribe("*", e), n;
+    const n = new F();
+    return this.subscribe("__internals__:clear", () => n.clear()), this.subscribe("*", (e, ...t) => {
+      n.publish(e, ...t);
+    }), n;
   }
-  /**
-   * Publishes an event to all the subscribers.
-   *
-   * ---
-   *
-   * @example
-   * ```ts
-   * publisher.subscribe("player:move", (coords) => { [...] });
-   * publisher.subscribe("player:move", ({ x, y }) => { [...] });
-   * publisher.subscribe("player:move", (evt) => { [...] });
-   *
-   * publisher.publish("player:move", { x: 10, y: 20 });
-   * ```
-   *
-   * ---
-   *
-   * @template K The key of the map containing the callback signature to publish.
-   *
-   * @param event The name of the event to publish.
-   * @param args The arguments to pass to the subscribers.
-   *
-   * @returns An array containing the return values of all the subscribers.
-   */
   publish(n, ...e) {
     let t, s = this._subscribers.get(n);
     return s ? t = s.slice().map((r) => r(...e)) : t = [], n.startsWith("__") || (s = this._subscribers.get("*"), s && s.slice().forEach((r) => r(n, ...e))), t;
   }
-  /**
-   * Subscribes to an event and adds a subscriber to be executed when the event is published.
-   *
-   * ---
-   *
-   * @example
-   * ```ts
-   * let unsubscribe: () => void;
-   * publisher.subscribe("player:death", unsubscribe);
-   * publisher.subscribe("player:spawn", (evt) =>
-   * {
-   *     unsubscribe = publisher.subscribe("player:move", ({ x, y }) => { [...] });
-   * });
-   * ```
-   *
-   * ---
-   *
-   * @template K The key of the map containing the callback signature to subscribe.
-   *
-   * @param event The name of the event to subscribe to.
-   * @param subscriber The subscriber to execute when the event is published.
-   *
-   * @returns A function that can be used to unsubscribe the subscriber from the event.
-   */
   subscribe(n, e) {
     const t = this._subscribers.get(n) ?? [];
     return t.push(e), this._subscribers.set(n, t), () => {
@@ -3766,26 +3718,6 @@ const F = class F {
       t.splice(s, 1);
     };
   }
-  /**
-   * Unsubscribes from an event and removes a subscriber from being executed when the event is published.
-   *
-   * ---
-   *
-   * @example
-   * ```ts
-   * const onPlayerMove = ({ x, y }: Point) => { [...] };
-   *
-   * publisher.subscribe("player:spawn", (evt) => publisher.subscribe("player:move", onPlayerMove));
-   * publisher.subscribe("player:death", () => publisher.unsubscribe("player:move", onPlayerMove));
-   * ```
-   *
-   * ---
-   *
-   * @template K The key of the map containing the callback signature to unsubscribe.
-   *
-   * @param event The name of the event to unsubscribe from.
-   * @param subscriber The subscriber to remove from the event.
-   */
   unsubscribe(n, e) {
     const t = this._subscribers.get(n);
     if (!t)
@@ -3868,7 +3800,7 @@ class dt extends (Se = Ue, ve = Symbol.toStringTag, Se) {
    *
    * @example
    * ```ts
-   * window.addEventListener("pointerdown", () => { onPointerMove.enable(); });
+   * window.addEventListener("pointerdown", () => onPointerMove.enable());
    * window.addEventListener("pointermove", onPointerMove);
    * ```
    *
@@ -3902,7 +3834,7 @@ class dt extends (Se = Ue, ve = Symbol.toStringTag, Se) {
    * @example
    * ```ts
    * window.addEventListener("pointermove", onPointerMove);
-   * window.addEventListener("pointerup", () => { onPointerMove.disable(); });
+   * window.addEventListener("pointerup", () => onPointerMove.disable());
    * ```
    */
   disable() {
@@ -3971,9 +3903,9 @@ class dt extends (Se = Ue, ve = Symbol.toStringTag, Se) {
    *
    * @example
    * ```ts
-   * window.addEventListener("pointerdown", () => { onPointerMove.switch("pressed"); });
+   * window.addEventListener("pointerdown", () => onPointerMove.switch("pressed"));
    * window.addEventListener("pointermove", onPointerMove);
-   * window.addEventListener("pointerup", () => { onPointerMove.switch("released"); });
+   * window.addEventListener("pointerup", () => onPointerMove.switch("released"));
    * ```
    *
    * ---
@@ -4094,8 +4026,8 @@ class wt extends (Te = Map, ke = Symbol.toStringTag, Te) {
    *     console.log(`Added ${key}: ${value}`);
    * });
    *
-   * map.set("key1", 2); // Added key1: 2
-   * map.set("answer", 42); // Added answer: 42
+   * map.set("key1", 2); // "Added key1: 2"
+   * map.set("answer", 42); // "Added answer: 42"
    * map.set("key2", 4);
    * map.set("key3", 8);
    * ```
@@ -4105,7 +4037,7 @@ class wt extends (Te = Map, ke = Symbol.toStringTag, Te) {
    * @template T The key of the map containing the callback signature to subscribe.
    *
    * @param event The name of the event to subscribe to.
-   * @param callback The callback to execute when the event is published.
+   * @param subscriber The callback to execute when the event is published.
    *
    * @returns A function that can be used to unsubscribe the callback from the event.
    */
@@ -4123,7 +4055,7 @@ class wt extends (Te = Map, ke = Symbol.toStringTag, Te) {
    * const map = new MapView<string, number>();
    *
    * map.subscribe("entry:add", callback);
-   * map.set("key1", 2); // Added key1: 2
+   * map.set("key1", 2); // "Added key1: 2"
    *
    * map.unsubscribe("entry:add", callback);
    * map.set("key2", 4);
@@ -4134,7 +4066,7 @@ class wt extends (Te = Map, ke = Symbol.toStringTag, Te) {
    * @template T The key of the map containing the callback signature to unsubscribe.
    *
    * @param event The name of the event to unsubscribe from.
-   * @param callback The callback to remove from the event.
+   * @param subscriber The callback to remove from the event.
    */
   unsubscribe(e, t) {
     this._publisher.unsubscribe(e, t);
@@ -4247,8 +4179,8 @@ class mt extends (Me = Set, Ee = Symbol.toStringTag, Me) {
    *     console.log(`Added ${value}`);
    * });
    *
-   * set.add(2); // Added 2
-   * set.add(42); // Added 42
+   * set.add(2); // "Added 2"
+   * set.add(42); // "Added 42"
    * set.add(4);
    * set.add(8);
    * ```
@@ -4258,7 +4190,7 @@ class mt extends (Me = Set, Ee = Symbol.toStringTag, Me) {
    * @template K The key of the map containing the callback signature to subscribe.
    *
    * @param event The name of the event to subscribe to.
-   * @param callback The callback to execute when the event is published.
+   * @param subscriber The callback to execute when the event is published.
    *
    * @returns A function that can be used to unsubscribe the callback from the event.
    */
@@ -4276,7 +4208,7 @@ class mt extends (Me = Set, Ee = Symbol.toStringTag, Me) {
    * const set = new SetView<number>();
    *
    * set.subscribe("entry:add", callback);
-   * set.add(2); // Added 2
+   * set.add(2); // "Added 2"
    *
    * set.unsubscribe("entry:add", callback);
    * set.add(4);
@@ -4287,7 +4219,7 @@ class mt extends (Me = Set, Ee = Symbol.toStringTag, Me) {
    * @template K The key of the map containing the callback signature to unsubscribe.
    *
    * @param event The name of the event to unsubscribe from.
-   * @param callback The callback to remove from the event.
+   * @param subscriber The callback to remove from the event.
    */
   unsubscribe(e, t) {
     this._publisher.unsubscribe(e, t);
@@ -5069,7 +5001,7 @@ class Ge {
    *
    * @example
    * ```ts
-   * loop.onStart(() => { console.log("The game loop has started."); });
+   * loop.onStart(() => console.log("The game loop has started."));
    * ```
    *
    * ---
@@ -5088,7 +5020,7 @@ class Ge {
    *
    * @example
    * ```ts
-   * loop.onStop(() => { console.log("The game loop has stopped."); });
+   * loop.onStop(() => console.log("The game loop has stopped."));
    * ```
    *
    * ---
@@ -5639,7 +5571,7 @@ function Ot(i) {
 function qt(i) {
   return `${i.charAt(0).toUpperCase()}${i.slice(1)}`;
 }
-const $t = "2.1.5";
+const $t = "2.1.7";
 export {
   M as AggregatedAsyncIterator,
   x as AggregatedIterator,