@byloth/core 2.1.7 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.1.7",
+  "version": "2.2.0",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -49,15 +49,15 @@
   },
   "types": "src/index.ts",
   "devDependencies": {
-    "@byloth/eslint-config-typescript": "^3.1.0",
-    "@eslint/compat": "^1.3.0",
-    "@types/node": "^22.15.32",
+    "@byloth/eslint-config-typescript": "^3.2.2",
+    "@eslint/compat": "^1.4.1",
+    "@types/node": "^22.19.0",
     "@vitest/coverage-v8": "^3.2.4",
-    "eslint": "^9.29.0",
+    "eslint": "^9.39.1",
     "husky": "^9.1.7",
-    "jsdom": "^26.1.0",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.5",
+    "jsdom": "^27.1.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.1",
     "vitest": "^3.2.4"
   },
   "scripts": {

package/src/index.ts

@@ -1,9 +1,8 @@
-export const VERSION = "2.1.7";
+export const VERSION = "2.2.0";
 
 export type { Constructor, Interval, Timeout, ValueOf } from "./core/types.js";
 
 export { isBrowser, isNode, isWorker } from "./helpers.js";
-
 export {
     AggregatedIterator,
     AggregatedAsyncIterator,
@@ -62,7 +61,6 @@ export type {
     KeyedIteratee,
     KeyedReducer,
     KeyedTypeGuardPredicate,
-    MapViewEventsMap,
     MaybeAsyncKeyedIteratee,
     MaybeAsyncKeyedReducer,
     MaybeAsyncGeneratorFunction,
@@ -78,7 +76,6 @@ export type {
     ReadonlySetView,
     Reducer,
     RejectedHandler,
-    SetViewEventsMap,
     Subscribable,
     TypeGuardPredicate,
     WildcardEventsMap

package/src/models/aggregators/aggregated-async-iterator.ts

@@ -507,8 +507,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * @returns
      * A {@link Promise} resolving to a new {@link ReducedIterator} containing the reduced results for each group.
      */
-    public async reduce<A extends PropertyKey>(reducer: MaybeAsyncKeyedReducer<K, T, A>, initialValue: MaybePromise<A>)
-        : Promise<ReducedIterator<K, A>>;
+    public async reduce<A extends PropertyKey>(
+        reducer: MaybeAsyncKeyedReducer<K, T, A>, initialValue: MaybePromise<A>
+    ): Promise<ReducedIterator<K, A>>;
 
     /**
      * Reduces the elements of the iterator using a given reducer function.  
@@ -545,8 +546,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * @returns
      * A {@link Promise} resolving to a new {@link ReducedIterator} containing the reduced results for each group.
      */
-    public async reduce<A>(reducer: MaybeAsyncKeyedReducer<K, T, A>, initialValue: (key: K) => MaybePromise<A>)
-        : Promise<ReducedIterator<K, A>>;
+    public async reduce<A>(
+        reducer: MaybeAsyncKeyedReducer<K, T, A>, initialValue: (key: K) => MaybePromise<A>
+    ): Promise<ReducedIterator<K, A>>;
     public async reduce<A>(
         reducer: MaybeAsyncKeyedReducer<K, T, A>, initialValue?: MaybePromise<A> | ((key: K) => MaybePromise<A>)
     ): Promise<ReducedIterator<K, A>>
@@ -810,9 +812,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * A {@link Promise} resolving to a new {@link ReducedIterator} containing
      * the first element that satisfies the condition for each group.
      */
-    public async find<S extends T>(predicate: MaybeAsyncKeyedIteratee<K, T, boolean>)
-        : Promise<ReducedIterator<K, S | undefined>>;
-
+    public async find<S extends T>(
+        predicate: MaybeAsyncKeyedIteratee<K, T, boolean>
+    ): Promise<ReducedIterator<K, S | undefined>>;
     public async find(predicate: MaybeAsyncKeyedIteratee<K, T, boolean>): Promise<ReducedIterator<K, T | undefined>>
     {
         const values = new Map<K, [number, T | undefined]>();
@@ -1020,8 +1022,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      *
      * @returns A new {@link AggregatedAsyncIterator} containing the elements reorganized by the new keys.
      */
-    public reorganizeBy<J extends PropertyKey>(iteratee: MaybeAsyncKeyedIteratee<K, T, J>)
-        : AggregatedAsyncIterator<J, T>
+    public reorganizeBy<J extends PropertyKey>(
+        iteratee: MaybeAsyncKeyedIteratee<K, T, J>
+    ): AggregatedAsyncIterator<J, T>
     {
         const elements = this._elements;
 

package/src/models/callbacks/callable-object.ts

@@ -1,7 +1,7 @@
 import type { Callback } from "./types.js";
 
 const SmartFunction = (Function as unknown) as new<A extends unknown[] = [], R = void>(...args: string[])
-    => Callback<A, R>;
+=> Callback<A, R>;
 
 /**
  * An abstract class that can be used to implement callable objects.
@@ -41,7 +41,7 @@ export default abstract class CallableObject<T extends Callback<any[], any> = Ca
      */
     public constructor()
     {
-        super(`return this._invoke(...arguments);`);
+        super("return this._invoke(...arguments);");
 
         const self = this.bind(this);
         Object.setPrototypeOf(this, self);

package/src/models/callbacks/publisher.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";
 }

package/src/models/callbacks/switchable-callback.ts

@@ -130,7 +130,6 @@ export default class SwitchableCallback<T extends Callback<any[], any> = Callbac
                     "The `SwitchableCallback` has no callback defined yet. " +
                     "Did you forget to call the `register` method?"
                 );
-
             }) as unknown) as T;
         }
 

package/src/models/callbacks/types.ts

@@ -87,14 +87,14 @@ 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 }]"
  * publisher.publish("player:death"); // "Event `player:death` was fired with args: []"
  * ```
  */
-export interface WildcardEventsMap { "*": (type: string, ...args: unknown[]) => void; }
+export interface WildcardEventsMap { "*": (type: string, ...args: unknown[]) => void }
 
 /**
  * An utility type that represents a {@link Publisher} object that can be published to.
@@ -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.

package/src/models/collections/map-view.ts

@@ -1,9 +1,16 @@
 import Publisher from "../callbacks/publisher.js";
-import type { Subscribable } from "../types.js";
+import type { Callback } from "../types.js";
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type SetView from "./set-view.js";
-import type { MapViewEventsMap } from "./types.js";
+
+interface MapViewEventsMap<K, V>
+{
+    "add": (key: K, value: V) => void;
+    "remove": (key: K, value: V) => void;
+
+    "clear": () => void;
+}
 
 /**
  * A wrapper class around the native {@link Map} class that provides additional functionality
@@ -17,7 +24,7 @@ import type { MapViewEventsMap } from "./types.js";
  * ```ts
  * const map = new MapView<string, number>();
  *
- * map.subscribe("entry:add", (key: string, value: number) => console.log(`Added ${key}: ${value}`));
+ * map.onAdd((key: string, value: number) => console.log(`Added ${key}: ${value}`));
  * map.set("answer", 42); // "Added answer: 42"
  * ```
  *
@@ -26,7 +33,7 @@ import type { MapViewEventsMap } from "./types.js";
  * @template K The type of the keys in the map.
  * @template V The type of the values in the map.
  */
-export default class MapView<K, V> extends Map<K, V> implements Subscribable<MapViewEventsMap<K, V>>
+export default class MapView<K, V> extends Map<K, V>
 {
     /**
      * The internal {@link Publisher} instance used to publish events.
@@ -86,7 +93,7 @@ export default class MapView<K, V> extends Map<K, V> implements Subscribable<Map
     {
         super.set(key, value);
 
-        this._publisher.publish("entry:add", key, value);
+        this._publisher.publish("add", key, value);
 
         return this;
     }
@@ -118,7 +125,7 @@ export default class MapView<K, V> extends Map<K, V> implements Subscribable<Map
 
         super.delete(key);
 
-        this._publisher.publish("entry:remove", key, value);
+        this._publisher.publish("remove", key, value);
 
         return true;
     }
@@ -141,72 +148,77 @@ export default class MapView<K, V> extends Map<K, V> implements Subscribable<Map
         const size = this.size;
 
         super.clear();
-        if (size > 0) { this._publisher.publish("collection:clear"); }
+        if (size > 0) { this._publisher.publish("clear"); }
     }
 
     /**
-     * Subscribes to an event and adds a callback to be executed when the event is published.
+     * Subscribes to the `add` event of the map with a callback that will be executed when an entry is added.
      *
      * ---
      *
      * @example
      * ```ts
-     * const map = new MapView<string, number>();
-     * const unsubscribe = map.subscribe("entry:add", (key: string, value: number) =>
-     * {
-     *     if (key === "answer") { unsubscribe(); }
-     *     console.log(`Added ${key}: ${value}`);
-     * });
+     * map.onAdd((key, value) => console.log(`Added ${key}: ${value}`));
      *
      * map.set("key1", 2); // "Added key1: 2"
      * map.set("answer", 42); // "Added answer: 42"
-     * map.set("key2", 4);
-     * map.set("key3", 8);
      * ```
      *
      * ---
      *
-     * @template T The key of the map containing the callback signature to subscribe.
-     *
-     * @param event The name of the event to subscribe to.
-     * @param subscriber The callback to execute when the event is published.
+     * @param callback The callback that will be executed when an entry is added to the map.
      *
-     * @returns A function that can be used to unsubscribe the callback from the event.
+     * @returns A function that can be used to unsubscribe from the event.
      */
-    public subscribe<T extends keyof MapViewEventsMap<K, V>>(event: T, subscriber: MapViewEventsMap<K, V>[T])
-        : () => void
+    public onAdd(callback: (key: K, value: V) => void): Callback
     {
-        return this._publisher.subscribe(event, subscriber);
+        return this._publisher.subscribe("add", callback);
     }
 
     /**
-     * Unsubscribes from an event and removes a callback from being executed when the event is published.
+     * Subscribes to the `remove` event of the map with a callback that will be executed when an entry is removed.
      *
      * ---
      *
      * @example
      * ```ts
-     * const callback = (key: string, value: number) => console.log(`Added ${key}: ${value}`);
-     * const map = new MapView<string, number>();
+     * map.onRemove((key, value) => console.log(`Removed ${key}: ${value}`));
      *
-     * map.subscribe("entry:add", callback);
-     * map.set("key1", 2); // "Added key1: 2"
+     * map.delete("key1"); // "Removed key1: 2"
+     * map.delete("answer"); // "Removed answer: 42"
+     * ```
+     *
+     * ---
      *
-     * map.unsubscribe("entry:add", callback);
-     * map.set("key2", 4);
+     * @param callback The callback that will be executed when an entry is removed from the map.
+     *
+     * @returns A function that can be used to unsubscribe from the event.
+     */
+    public onRemove(callback: (key: K, value: V) => void): Callback
+    {
+        return this._publisher.subscribe("remove", callback);
+    }
+
+    /**
+     * Subscribes to the `clear` event of the map with a callback that will be executed when the map is cleared.
+     *
+     * ---
+     *
+     * @example
+     * ```ts
+     * map.onClear(() => console.log("The map has all been cleared."));
+     * map.clear(); // "The map has all been cleared."
      * ```
      *
      * ---
      *
-     * @template T The key of the map containing the callback signature to unsubscribe.
+     * @param callback The callback that will be executed when the map is cleared.
      *
-     * @param event The name of the event to unsubscribe from.
-     * @param subscriber The callback to remove from the event.
+     * @returns A function that can be used to unsubscribe from the event.
      */
-    public unsubscribe<T extends keyof MapViewEventsMap<K, V>>(event: T & string, subscriber: MapViewEventsMap<K, V>[T])
-        : void
+    public onClear(callback: () => void): Callback
     {
-        this._publisher.unsubscribe(event, subscriber);
+        return this._publisher.subscribe("clear", callback);
     }
 
     public override readonly [Symbol.toStringTag]: string = "MapView";