imp: Implemented new unsubscribeAll method on Publisher object class.

Author: Byloth

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.1.7",
+  "version": "2.1.8",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -61,14 +61,14 @@
   },
   "devDependencies": {
     "@byloth/eslint-config-typescript": "^3.2.2",
-    "@eslint/compat": "^1.4.0",
-    "@types/node": "^22.18.6",
+    "@eslint/compat": "^1.4.1",
+    "@types/node": "^22.19.0",
     "@vitest/coverage-v8": "^3.2.4",
-    "eslint": "^9.36.0",
+    "eslint": "^9.39.1",
     "husky": "^9.1.7",
-    "jsdom": "^27.0.0",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.7",
+    "jsdom": "^27.1.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.1",
     "vitest": "^3.2.4"
   }
 }

pnpm-lock.yaml

@@ -1,9 +1,8 @@
-export const VERSION = "2.1.7";
+export const VERSION = "2.1.8";
 
 export type { Constructor, Interval, Timeout, ValueOf } from "./core/types.js";
 
 export { isBrowser, isNode, isWorker } from "./helpers.js";
-
 export {
     AggregatedIterator,
     AggregatedAsyncIterator,

src/index.ts

@@ -68,33 +68,6 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
         this._subscribers = new Map();
     }
 
-    /**
-     * Unsubscribes all the subscribers from all the events.
-     *
-     * ---
-     *
-     * @example
-     * ```ts
-     * publisher.subscribe("player:spawn", (evt) => { [...] });
-     * publisher.subscribe("player:move", (coords) => { [...] });
-     * publisher.subscribe("player:move", () => { [...] });
-     * publisher.subscribe("player:move", ({ x, y }) => { [...] });
-     * publisher.subscribe("player:death", () => { [...] });
-     *
-     * // All these subscribers are working fine...
-     *
-     * publisher.clear();
-     *
-     * // ... but now they're all gone!
-     * ```
-     */
-    public clear(): void
-    {
-        this.publish("__internals__:clear");
-
-        this._subscribers.clear();
-    }
-
     /**
      * Creates a new scoped instance of the {@link Publisher} class,
      * which can be used to publish and subscribe events within a specific context.
@@ -110,8 +83,8 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      * 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."
      * context.publish("player:death"); // * no output *
@@ -239,7 +212,7 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      *
      * @returns A function that can be used to unsubscribe the subscriber from the event.
      */
-    public subscribe<K extends keyof T>(event: K & string, subscriber: T[K]): () => void;
+    public subscribe<K extends keyof T>(event: K & string, subscriber: T[K]): Callback;
 
     /**
      * Subscribes to the wildcard event to listen to all published events.
@@ -253,21 +226,21 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      * ```ts
      * publisher.subscribe("*", (type, ...args) =>
      * {
-     *     console.log(`Event \`${type}\` was fired with args:`, args);
+     *     console.log(`Event "${type}" was fired with args:`, args);
      * });
      * ```
      *
      * ---
      *
-     * @template K The key of the wildcard events map (always "*").
+     * @template K The key of the wildcard events map (always `*`).
      *
-     * @param event The wildcard event name ("*").
+     * @param event The wildcard event name (`*`).
      * @param subscriber The subscriber to execute for all published events.
      *
      * @returns A function that can be used to unsubscribe the subscriber from the wildcard event.
      */
-    public subscribe<K extends keyof S>(event: K & string, subscriber: S[K]): () => void;
-    public subscribe(event: string, subscriber: Callback<unknown[], unknown>): () => void
+    public subscribe<K extends keyof S>(event: K & string, subscriber: S[K]): Callback;
+    public subscribe(event: string, subscriber: Callback<unknown[], unknown>): Callback
     {
         const subscribers = this._subscribers.get(event) ?? [];
         subscribers.push(subscriber);
@@ -326,9 +299,9 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      *
      * ---
      *
-     * @template K The key of the wildcard events map (always "*").
+     * @template K The key of the wildcard events map (always `*`).
      *
-     * @param event The wildcard event name ("*").
+     * @param event The wildcard event name (`*`).
      * @param subscriber The wildcard subscriber to remove.
      */
     public unsubscribe<K extends keyof S>(event: K & string, subscriber: S[K]): void;
@@ -352,5 +325,94 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
         if (subscribers.length === 0) { this._subscribers.delete(event); }
     }
 
+    /**
+     * Unsubscribes all subscribers from a specific event and removes
+     * them from being executed when the event is published.
+     *
+     * ---
+     *
+     * @example
+     * ```ts
+     * publisher.subscribe("player:spawn", (evt) => { [...] });
+     * publisher.subscribe("player:move", (coords) => { [...] });
+     * publisher.subscribe("player:move", () => { [...] });
+     * publisher.subscribe("player:move", ({ x, y }) => { [...] });
+     * publisher.subscribe("player:death", () => { [...] });
+     *
+     * // All these subscribers are working fine...
+     *
+     * publisher.unsubscribeAll("player:move");
+     *
+     * // ... but now "player:move" subscribers are gone!
+     * ```
+     *
+     * ---
+     *
+     * @template K The key of the map containing the event to clear.
+     *
+     * @param event The name of the event to unsubscribe all subscribers from.
+     */
+    public unsubscribeAll<K extends keyof T>(event: K & string): void;
+
+    /**
+     * Unsubscribes all subscribers from the wildcard event and removes
+     * them from being executed for all published events.
+     *
+     * ---
+     *
+     * @example
+     * ```ts
+     * publisher.subscribe("player:spawn", (evt) => { [...] });
+     * publisher.subscribe("*", (type, ...args) => { [...] });
+     * publisher.subscribe("*", (type, arg1, arg2, arg3) => { [...] });
+     * publisher.subscribe("*", (_, arg, ...rest) => { [...] });
+     * publisher.subscribe("player:death", () => { [...] });
+     *
+     * // All these subscribers are working fine...
+     *
+     * publisher.unsubscribeAll("*");
+     *
+     * // ... but now wildcard subscribers are gone!
+     * ```
+     *
+     * ---
+     *
+     * @template K The key of the wildcard events map (`*`).
+     *
+     * @param event The wildcard event name (`*`).
+     */
+    public unsubscribeAll<K extends keyof S>(event: K & string): void;
+    public unsubscribeAll(event: string): void
+    {
+        this._subscribers.delete(event);
+    }
+
+    /**
+     * Unsubscribes all the subscribers from all the events.
+     *
+     * ---
+     *
+     * @example
+     * ```ts
+     * publisher.subscribe("player:spawn", (evt) => { [...] });
+     * publisher.subscribe("player:move", (coords) => { [...] });
+     * publisher.subscribe("*", () => { [...] });
+     * publisher.subscribe("player:move", ({ x, y }) => { [...] });
+     * publisher.subscribe("player:death", () => { [...] });
+     *
+     * // All these subscribers are working fine...
+     *
+     * publisher.clear();
+     *
+     * // ... but now they're all gone!
+     * ```
+     */
+    public clear(): void
+    {
+        this.publish("__internals__:clear");
+
+        this._subscribers.clear();
+    }
+
     public readonly [Symbol.toStringTag]: string = "Publisher";
 }

src/models/callbacks/publisher.ts

@@ -87,7 +87,7 @@ export type InternalsEventsMap = Record<`__${string}__:${string}`, Callback<unkn
  *
  * publisher.subscribe("*", (type: string, ...args: unknown[]) =>
  * {
- *     console.log(`Event \`${type}\` was fired with args:`, args));
+ *     console.log(`Event "${type}" was fired with args:`, args));
  * });
  * 
  * publisher.publish("player:move", { x: 10, y: 20 }); // "Event `player:move` was fired with args: [{ x: 10, y: 20 }]"
@@ -178,7 +178,7 @@ export interface Subscribable<T extends CallbackMap<T> = CallbackMap>
      *
      * @returns A function that can be used to unsubscribe the subscriber from the event.
      */
-    subscribe<K extends keyof T>(event: K & string, subscriber: T[K]): () => void;
+    subscribe<K extends keyof T>(event: K & string, subscriber: T[K]): Callback;
 
     /**
      * Unsubscribes from an event and removes a subscriber from being executed when the event is published.

src/models/callbacks/types.ts

@@ -1,5 +1,5 @@
 import Publisher from "../callbacks/publisher.js";
-import type { Subscribable } from "../types.js";
+import type { Callback, Subscribable } from "../types.js";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type SetView from "./set-view.js";
@@ -174,8 +174,8 @@ export default class MapView<K, V> extends Map<K, V> implements Subscribable<Map
      * @returns A function that can be used to unsubscribe the callback from the event.
      */
     public subscribe<T extends keyof MapViewEventsMap<K, V>>(
-        event: T, subscriber: MapViewEventsMap<K, V>[T]
-    ): () => void
+        event: T & string, subscriber: MapViewEventsMap<K, V>[T]
+    ): Callback
     {
         return this._publisher.subscribe(event, subscriber);
     }

src/models/collections/map-view.ts

@@ -1,5 +1,5 @@
 import Publisher from "../callbacks/publisher.js";
-import type { Subscribable } from "../types.js";
+import type { Callback, Subscribable } from "../types.js";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type MapView from "./map-view.js";
@@ -169,7 +169,7 @@ export default class SetView<T> extends Set<T> implements Subscribable<SetViewEv
      */
     public subscribe<K extends keyof SetViewEventsMap<T>>(
         event: K & string, subscriber: SetViewEventsMap<T>[K]
-    ): () => void
+    ): Callback
     {
         return this._publisher.subscribe(event, subscriber);
     }

src/models/collections/set-view.ts

@@ -1,3 +1,5 @@
+import type { Callback } from "../types.js";
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type MapView from "./map-view.js";
 
@@ -66,7 +68,7 @@ export interface ReadonlyMapView<K, V> extends ReadonlyMap<K, V>
      *
      * @returns A function that can be used to unsubscribe the callback from the event.
      */
-    subscribe<T extends keyof MapViewEventsMap<K, V>>(event: T, callback: MapViewEventsMap<K, V>[T]): () => void;
+    subscribe<T extends keyof MapViewEventsMap<K, V>>(event: T & string, callback: MapViewEventsMap<K, V>[T]): Callback;
 
     /**
      * Unsubscribes from an event and removes a callback from being executed when the event is published.
@@ -92,7 +94,7 @@ export interface ReadonlyMapView<K, V> extends ReadonlyMap<K, V>
      * @param event The name of the event to unsubscribe from.
      * @param callback The callback to remove from the event.
      */
-    unsubscribe<T extends keyof MapViewEventsMap<K, V>>(event: T, callback: MapViewEventsMap<K, V>[T]): void;
+    unsubscribe<T extends keyof MapViewEventsMap<K, V>>(event: T & string, callback: MapViewEventsMap<K, V>[T]): void;
 }
 
 /**
@@ -155,7 +157,7 @@ export interface ReadonlySetView<T> extends ReadonlySet<T>
      *
      * @returns A function that can be used to unsubscribe the callback from the event.
      */
-    subscribe<K extends keyof SetViewEventsMap<T>>(event: K, callback: SetViewEventsMap<T>[K]): () => void;
+    subscribe<K extends keyof SetViewEventsMap<T>>(event: K & string, callback: SetViewEventsMap<T>[K]): Callback;
 
     /**
      * Unsubscribes from an event and removes a callback from being executed when the event is published.
@@ -181,5 +183,5 @@ export interface ReadonlySetView<T> extends ReadonlySet<T>
      * @param event The name of the event to unsubscribe from.
      * @param callback The callback to remove from the event.
      */
-    unsubscribe<K extends keyof SetViewEventsMap<T>>(event: K, callback: SetViewEventsMap<T>[K]): void;
+    unsubscribe<K extends keyof SetViewEventsMap<T>>(event: K & string, callback: SetViewEventsMap<T>[K]): void;
 }

src/models/collections/types.ts

@@ -1,3 +1,4 @@
+import type { Callback } from "../types.js";
 import type { FulfilledHandler, PromiseExecutor, RejectedHandler } from "./types.js";
 
 /**
@@ -333,7 +334,7 @@ export default class SmartPromise<T = void> implements Promise<T>
      *
      * @returns A new {@link Promise} that executes the callback once the promise is settled.
      */
-    public finally(onFinally?: (() => void) | null): Promise<T>
+    public finally(onFinally?: Callback | null): Promise<T>
     {
         return this._promise.finally(onFinally);
     }

src/models/promises/smart-promise.ts

@@ -2,6 +2,7 @@ import { TimeUnit } from "../../utils/date.js";
 
 import type Publisher from "../callbacks/publisher.js";
 import { FatalErrorException, RangeException, RuntimeException } from "../exceptions/index.js";
+import type { Callback } from "../types.js";
 
 import GameLoop from "./game-loop.js";
 
@@ -136,7 +137,7 @@ export default class Clock extends GameLoop
      *
      * @returns A function that can be used to unsubscribe from the event.
      */
-    public onTick(callback: (elapsedTime: number) => void, tickStep = 0): () => void
+    public onTick(callback: (elapsedTime: number) => void, tickStep = 0): Callback
     {
         if (tickStep < 0) { throw new RangeException("The tick step must be a non-negative number."); }
         if (tickStep === 0) { return this._publisher.subscribe("tick", callback); }