@d1g1tal/subscribr 4.0.2 → 4.0.3

package/dist/subscribr.d.ts

@@ -6,22 +6,22 @@ declare class ContextEventHandler {
     private readonly context;
     private readonly eventListener;
     /**
-     * @param {unknown} context The context to bind to the event handler.
-     * @param {ContextEventListener} eventListener The event handler to call when the event is published.
+     * @param context The context to bind to the event handler.
+     * @param eventListener The event handler to call when the event is published.
      */
     constructor(context: unknown, eventListener: ContextEventListener);
     /**
      * Call the event handler for the provided event.
      *
-     * @param {Event} event The event to handle
-     * @param {unknown?} [data] The value to be passed to the event handler as a parameter.
+     * @param event The event to handle
+     * @param data The value to be passed to the event handler as a parameter.
      */
     handle(event: Event, data?: unknown): void;
     /**
      * A String value that is used in the creation of the default string
      * description of an object. Called by the built-in method {@link Object.prototype.toString}.
      *
-     * @returns {string} The default string description of this object.
+     * @returns The default string description of this object.
      */
     get [Symbol.toStringTag](): string;
 }
@@ -31,77 +31,72 @@ declare class Subscription {
     private readonly _eventName;
     private readonly _contextEventHandler;
     /**
-     * @param {string} eventName The event name.
-     * @param {ContextEventHandler} contextEventHandler Then context event handler.
+     * @param eventName The event name.
+     * @param contextEventHandler The context event handler.
      */
     constructor(eventName: string, contextEventHandler: ContextEventHandler);
     /**
      * Gets the event name for the subscription.
      *
-     * @returns {string} The event name.
+     * @returns The event name.
      */
     get eventName(): string;
     /**
      * Gets the context event handler.
      *
-     * @returns {ContextEventHandler} The context event handler
+     * @returns The context event handler
      */
     get contextEventHandler(): ContextEventHandler;
     /**
      * A String value that is used in the creation of the default string
      * description of an object. Called by the built-in method {@link Object.prototype.toString}.
      *
-     * @returns {string} The default string description of this object.
+     * @returns The default string description of this object.
      */
     get [Symbol.toStringTag](): string;
 }
 
-/**
- * A class that allows objects to subscribe to events and be notified when the event is published.
- *
- * @class
- * @exports Subscribr
- */
+/** A class that allows objects to subscribe to events and be notified when the event is published. */
 declare class Subscribr {
     private readonly subscribers;
     constructor();
     /**
      * Subscribe to an event
      *
-     * @param {string} eventName The event name to subscribe to.
-     * @param {ContextEventListener} eventHandler The event handler to call when the event is published.
-     * @param {unknown} [context] The context to bind to the event handler.
-     * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.
+     * @param eventName The event name to subscribe to.
+     * @param eventHandler The event handler to call when the event is published.
+     * @param context The context to bind to the event handler.
+     * @returns An object used to check if the subscription still exists and to unsubscribe from the event.
      */
     subscribe(eventName: string, eventHandler: ContextEventListener, context?: unknown): Subscription;
     /**
      * Unsubscribe from the event
      *
-     * @param {Subscription} subscription The subscription to unsubscribe.
-     * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.
+     * @param subscription The subscription to unsubscribe.
+     * @returns true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.
      */
     unsubscribe({ eventName, contextEventHandler }: Subscription): boolean;
     /**
      * Publish an event
      *
      * @template T
-     * @param {string} eventName The name of the event.
-     * @param {Event} [event=new CustomEvent(eventName)] The event to be handled.
-     * @param {T} [data] The value to be passed to the event handler as a parameter.
+     * @param eventName The name of the event.
+     * @param event The event to be handled.
+     * @param data The value to be passed to the event handler as a parameter.
      */
     publish<T>(eventName: string, event?: Event, data?: T): void;
     /**
      * Check if the event and handler are subscribed.
      *
-     * @param {Subscription} subscription The subscription object.
-     * @returns {boolean} true if the event name and handler are subscribed, false otherwise.
+     * @param subscription The subscription object.
+     * @returns true if the event name and handler are subscribed, false otherwise.
      */
     isSubscribed({ eventName, contextEventHandler }: Subscription): boolean;
     /**
      * A String value that is used in the creation of the default string
      * description of an object. Called by the built-in method {@link Object.prototype.toString}.
      *
-     * @returns {string} The default string description of this object.
+     * @returns The default string description of this object.
      */
     get [Symbol.toStringTag](): string;
 }

package/dist/subscribr.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../node_modules/.pnpm/@d1g1tal+collections@2.0.2_typescript@5.8.3/node_modules/@d1g1tal/collections/src/set-multi-map.ts", "../src/context-event-handler.ts", "../src/subscription.ts", "../src/subscribr.ts"],
-  "sourcesContent": ["/** A {@link Map} that can contain multiple, unique, values for the same key. */\nexport class SetMultiMap<K, V> extends Map<K, Set<V>>{\n\t/**\n\t * Adds a new element with a specified key and value to the SetMultiMap.\n\t * If an element with the same key already exists, the value will be added to the underlying {@link Set}.\n\t * If the value already exists in the {@link Set}, it will not be added again.\n\t *\n\t * @param {K} key The key to set.\n\t * @param {V} value The value to add to the SetMultiMap\n\t * @returns {SetMultiMap<K, V>} The SetMultiMap with the updated key and value.\n\t */\n\t// @ts-expect-error I am overriding the set method from the Map class\n\toverride set(key: K, value: V): SetMultiMap<K, V> {\n\t\tsuper.set(key, (super.get(key) ?? new Set()).add(value));\n\n\t\treturn this;\n\t}\n\n\t/**\n\t * Checks if a specific key has a specific value.\n\t *\n\t * @param {K} key The key to check.\n\t * @param {V} value The value to check.\n\t * @returns {boolean} True if the key has the value, false otherwise.\n\t */\n\thasValue(key: K, value: V): boolean {\n\t\tconst values = super.get(key);\n\n\t\treturn values ? values.has(value) : false;\n\t}\n\n\tfind(key: K, iterator: (value: V) => boolean): V | undefined {\n\t\tconst values = this.get(key);\n\n\t\tif (values !== undefined) {\n\t\t\treturn Array.from(values).find(iterator);\n\t\t}\n\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * Removes a specific value from a specific key.\n\t *\n\t * @param {K} key The key to remove the value from.\n\t * @param {V | undefined} value The value to remove.\n\t * @returns {boolean} True if the value was removed, false otherwise.\n\t */\n\tdeleteValue(key: K, value: V | undefined): boolean {\n\t\tif (value === undefined) { return this.delete(key) }\n\n\t\tconst values = super.get(key);\n\t\tif (values) {\n\t\t\tconst deleted = values.delete(value);\n\n\t\t\tif (values.size === 0) {\n\t\t\t\tsuper.delete(key);\n\t\t\t}\n\n\t\t\treturn deleted;\n\t\t}\n\n\t\treturn false;\n\t}\n\n\toverride get [Symbol.toStringTag](): string {\n\t\treturn 'SetMultiMap';\n\t}\n}", "import type { ContextEventListener } from './@types';\n\n/** A wrapper for an event handler that binds a context to the event handler. */\nexport class ContextEventHandler {\n\tprivate readonly context: unknown;\n\tprivate readonly eventListener: ContextEventListener;\n\n\t/**\n\t * @param {unknown} context The context to bind to the event handler.\n\t * @param {ContextEventListener} eventListener The event handler to call when the event is published.\n\t */\n\tconstructor(context: unknown, eventListener: ContextEventListener) {\n\t\tthis.context = context;\n\t\tthis.eventListener = eventListener;\n\t}\n\n\t/**\n\t * Call the event handler for the provided event.\n\t *\n\t * @param {Event} event The event to handle\n\t * @param {unknown?} [data] The value to be passed to the event handler as a parameter.\n\t */\n\thandle(event: Event, data?: unknown): void {\n\t\tthis.eventListener.call(this.context, event, data);\n\t}\n\n\t/**\n\t * A String value that is used in the creation of the default string\n\t * description of an object. Called by the built-in method {@link Object.prototype.toString}.\n\t *\n\t * @returns {string} The default string description of this object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'ContextEventHandler';\n\t}\n}", "import type { ContextEventHandler } from './context-event-handler';\n\n/** Represents a subscription to an event. */\nexport class Subscription {\n\tprivate readonly _eventName: string;\n\tprivate readonly _contextEventHandler: ContextEventHandler;\n\n\t/**\n\t * @param {string} eventName The event name.\n\t * @param {ContextEventHandler} contextEventHandler Then context event handler.\n\t */\n\tconstructor(eventName: string, contextEventHandler: ContextEventHandler) {\n\t\tthis._eventName = eventName;\n\t\tthis._contextEventHandler = contextEventHandler;\n\t}\n\n\t/**\n\t * Gets the event name for the subscription.\n\t *\n\t * @returns {string} The event name.\n\t */\n\tget eventName(): string {\n\t\treturn this._eventName;\n\t}\n\n\t/**\n\t * Gets the context event handler.\n\t *\n\t * @returns {ContextEventHandler} The context event handler\n\t */\n\tget contextEventHandler(): ContextEventHandler {\n\t\treturn this._contextEventHandler;\n\t}\n\n\t/**\n\t * A String value that is used in the creation of the default string\n\t * description of an object. Called by the built-in method {@link Object.prototype.toString}.\n\t *\n\t * @returns {string} The default string description of this object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'Subscription';\n\t}\n}", "import { SetMultiMap } from '@d1g1tal/collections/src';\nimport { ContextEventHandler } from './context-event-handler';\nimport { Subscription } from './subscription';\nimport type { ContextEventListener } from './@types';\n\n/**\n * A class that allows objects to subscribe to events and be notified when the event is published.\n *\n * @class\n * @exports Subscribr\n */\nexport class Subscribr {\n\tprivate readonly subscribers: SetMultiMap<string, ContextEventHandler>;\n\n\tconstructor() {\n\t\tthis.subscribers = new SetMultiMap();\n\t}\n\n\t/**\n\t * Subscribe to an event\n\t *\n\t * @param {string} eventName The event name to subscribe to.\n\t * @param {ContextEventListener} eventHandler The event handler to call when the event is published.\n\t * @param {unknown} [context] The context to bind to the event handler.\n\t * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.\n\t */\n\tsubscribe(eventName: string, eventHandler: ContextEventListener, context: unknown = eventHandler): Subscription {\n\t\tconst contextEventHandler = new ContextEventHandler(context, eventHandler);\n\t\tthis.subscribers.set(eventName, contextEventHandler);\n\n\t\treturn new Subscription(eventName, contextEventHandler);\n\t}\n\n\t/**\n\t * Unsubscribe from the event\n\t *\n\t * @param {Subscription} subscription The subscription to unsubscribe.\n\t * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.\n\t */\n\tunsubscribe({ eventName, contextEventHandler }: Subscription): boolean {\n\t\tconst contextEventHandlers = this.subscribers.get(eventName) ?? new Set();\n\t\tconst removed = contextEventHandlers.delete(contextEventHandler);\n\n\t\tif (removed && contextEventHandlers.size === 0) {\tthis.subscribers.delete(eventName) }\n\n\t\treturn removed;\n\t}\n\n\t/**\n\t * Publish an event\n\t *\n\t * @template T\n\t * @param {string} eventName The name of the event.\n\t * @param {Event} [event=new CustomEvent(eventName)] The event to be handled.\n\t * @param {T} [data] The value to be passed to the event handler as a parameter.\n\t */\n\tpublish<T>(eventName: string, event: Event = new CustomEvent(eventName), data?: T): void {\n\t\tthis.subscribers.get(eventName)?.forEach((contextEventHandler: ContextEventHandler) => contextEventHandler.handle(event, data));\n\t}\n\n\t/**\n\t * Check if the event and handler are subscribed.\n\t *\n\t * @param {Subscription} subscription The subscription object.\n\t * @returns {boolean} true if the event name and handler are subscribed, false otherwise.\n\t */\n\tisSubscribed({ eventName, contextEventHandler }: Subscription): boolean {\n\t\treturn this.subscribers.get(eventName)?.has(contextEventHandler) ?? false;\n\t}\n\n\t/**\n\t * A String value that is used in the creation of the default string\n\t * description of an object. Called by the built-in method {@link Object.prototype.toString}.\n\t *\n\t * @returns {string} The default string description of this object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'Subscribr';\n\t}\n}"],
-  "mappings": "AACO,IAAMA,EAAN,cAAgC,GAAc,CAW3C,IAAIC,EAAQC,EAA6B,CACjD,aAAM,IAAID,GAAM,MAAM,IAAIA,CAAG,GAAK,IAAI,KAAO,IAAIC,CAAK,CAAC,EAEhD,IACR,CASA,SAASD,EAAQC,EAAmB,CACnC,IAAMC,EAAS,MAAM,IAAIF,CAAG,EAE5B,OAAOE,EAASA,EAAO,IAAID,CAAK,EAAI,EACrC,CAEA,KAAKD,EAAQG,EAAgD,CAC5D,IAAMD,EAAS,KAAK,IAAIF,CAAG,EAE3B,GAAIE,IAAW,OACd,OAAO,MAAM,KAAKA,CAAM,EAAE,KAAKC,CAAQ,CAIzC,CASA,YAAYH,EAAQC,EAA+B,CAClD,GAAIA,IAAU,OAAa,OAAO,KAAK,OAAOD,CAAG,EAEjD,IAAME,EAAS,MAAM,IAAIF,CAAG,EAC5B,GAAIE,EAAQ,CACX,IAAME,EAAUF,EAAO,OAAOD,CAAK,EAEnC,OAAIC,EAAO,OAAS,GACnB,MAAM,OAAOF,CAAG,EAGVI,CACR,CAEA,MAAO,EACR,CAEA,IAAc,OAAO,WAAW,GAAY,CAC3C,MAAO,aACR,CACD,ECjEO,IAAMC,EAAN,KAA0B,CACf,QACA,cAMjB,YAAYC,EAAkBC,EAAqC,CAClE,KAAK,QAAUD,EACf,KAAK,cAAgBC,CACtB,CAQA,OAAOC,EAAcC,EAAsB,CAC1C,KAAK,cAAc,KAAK,KAAK,QAASD,EAAOC,CAAI,CAClD,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,qBACR,CACD,EChCO,IAAMC,EAAN,KAAmB,CACR,WACA,qBAMjB,YAAYC,EAAmBC,EAA0C,CACxE,KAAK,WAAaD,EAClB,KAAK,qBAAuBC,CAC7B,CAOA,IAAI,WAAoB,CACvB,OAAO,KAAK,UACb,CAOA,IAAI,qBAA2C,CAC9C,OAAO,KAAK,oBACb,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,cACR,CACD,EChCO,IAAMC,EAAN,KAAgB,CACL,YAEjB,aAAc,CACb,KAAK,YAAc,IAAIC,CACxB,CAUA,UAAUC,EAAmBC,EAAoCC,EAAmBD,EAA4B,CAC/G,IAAME,EAAsB,IAAIC,EAAoBF,EAASD,CAAY,EACzE,YAAK,YAAY,IAAID,EAAWG,CAAmB,EAE5C,IAAIE,EAAaL,EAAWG,CAAmB,CACvD,CAQA,YAAY,CAAE,UAAAH,EAAW,oBAAAG,CAAoB,EAA0B,CACtE,IAAMG,EAAuB,KAAK,YAAY,IAAIN,CAAS,GAAK,IAAI,IAC9DO,EAAUD,EAAqB,OAAOH,CAAmB,EAE/D,OAAII,GAAWD,EAAqB,OAAS,GAAK,KAAK,YAAY,OAAON,CAAS,EAE5EO,CACR,CAUA,QAAWP,EAAmBQ,EAAe,IAAI,YAAYR,CAAS,EAAGS,EAAgB,CACxF,KAAK,YAAY,IAAIT,CAAS,GAAG,QAASG,GAA6CA,EAAoB,OAAOK,EAAOC,CAAI,CAAC,CAC/H,CAQA,aAAa,CAAE,UAAAT,EAAW,oBAAAG,CAAoB,EAA0B,CACvE,OAAO,KAAK,YAAY,IAAIH,CAAS,GAAG,IAAIG,CAAmB,GAAK,EACrE,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,WACR,CACD",
+  "sources": ["../node_modules/.pnpm/@d1g1tal+collections@2.0.3_typescript@5.9.2/node_modules/@d1g1tal/collections/src/set-multi-map.ts", "../src/context-event-handler.ts", "../src/subscription.ts", "../src/subscribr.ts"],
+  "sourcesContent": ["/** A {@link Map} that can contain multiple, unique, values for the same key. */\nexport class SetMultiMap<K, V> extends Map<K, Set<V>>{\n\t/**\n\t * Adds a new element with a specified key and value to the SetMultiMap.\n\t * If an element with the same key already exists, the value will be added to the underlying {@link Set}.\n\t * If the value already exists in the {@link Set}, it will not be added again.\n\t *\n\t * @param {K} key The key to set.\n\t * @param {V} value The value to add to the SetMultiMap\n\t * @returns {SetMultiMap<K, V>} The SetMultiMap with the updated key and value.\n\t */\n\t// @ts-expect-error I am overriding the set method from the Map class\n\toverride set(key: K, value: V): SetMultiMap<K, V> {\n\t\tsuper.set(key, (super.get(key) ?? new Set()).add(value));\n\n\t\treturn this;\n\t}\n\n\t/**\n\t * Checks if a specific key has a specific value.\n\t *\n\t * @param {K} key The key to check.\n\t * @param {V} value The value to check.\n\t * @returns {boolean} True if the key has the value, false otherwise.\n\t */\n\thasValue(key: K, value: V): boolean {\n\t\tconst values = super.get(key);\n\n\t\treturn values ? values.has(value) : false;\n\t}\n\n\tfind(key: K, iterator: (value: V) => boolean): V | undefined {\n\t\tconst values = this.get(key);\n\n\t\tif (values !== undefined) {\n\t\t\treturn Array.from(values).find(iterator);\n\t\t}\n\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * Removes a specific value from a specific key.\n\t *\n\t * @param {K} key The key to remove the value from.\n\t * @param {V | undefined} value The value to remove.\n\t * @returns {boolean} True if the value was removed, false otherwise.\n\t */\n\tdeleteValue(key: K, value: V | undefined): boolean {\n\t\tif (value === undefined) { return this.delete(key) }\n\n\t\tconst values = super.get(key);\n\t\tif (values) {\n\t\t\tconst deleted = values.delete(value);\n\n\t\t\tif (values.size === 0) {\n\t\t\t\tsuper.delete(key);\n\t\t\t}\n\n\t\t\treturn deleted;\n\t\t}\n\n\t\treturn false;\n\t}\n\n\toverride get [Symbol.toStringTag](): string {\n\t\treturn 'SetMultiMap';\n\t}\n}", "import type { ContextEventListener } from './@types';\n\n/** A wrapper for an event handler that binds a context to the event handler. */\nexport class ContextEventHandler {\n\tprivate readonly context: unknown;\n\tprivate readonly eventListener: ContextEventListener;\n\n\t/**\n\t * @param context The context to bind to the event handler.\n\t * @param eventListener The event handler to call when the event is published.\n\t */\n\tconstructor(context: unknown, eventListener: ContextEventListener) {\n\t\tthis.context = context;\n\t\tthis.eventListener = eventListener;\n\t}\n\n\t/**\n\t * Call the event handler for the provided event.\n\t *\n\t * @param event The event to handle\n\t * @param data The value to be passed to the event handler as a parameter.\n\t */\n\thandle(event: Event, data?: unknown): void {\n\t\tthis.eventListener.call(this.context, event, data);\n\t}\n\n\t/**\n\t * A String value that is used in the creation of the default string\n\t * description of an object. Called by the built-in method {@link Object.prototype.toString}.\n\t *\n\t * @returns The default string description of this object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'ContextEventHandler';\n\t}\n}", "import type { ContextEventHandler } from './context-event-handler';\n\n/** Represents a subscription to an event. */\nexport class Subscription {\n\tprivate readonly _eventName: string;\n\tprivate readonly _contextEventHandler: ContextEventHandler;\n\n\t/**\n\t * @param eventName The event name.\n\t * @param contextEventHandler The context event handler.\n\t */\n\tconstructor(eventName: string, contextEventHandler: ContextEventHandler) {\n\t\tthis._eventName = eventName;\n\t\tthis._contextEventHandler = contextEventHandler;\n\t}\n\n\t/**\n\t * Gets the event name for the subscription.\n\t *\n\t * @returns The event name.\n\t */\n\tget eventName(): string {\n\t\treturn this._eventName;\n\t}\n\n\t/**\n\t * Gets the context event handler.\n\t *\n\t * @returns The context event handler\n\t */\n\tget contextEventHandler(): ContextEventHandler {\n\t\treturn this._contextEventHandler;\n\t}\n\n\t/**\n\t * A String value that is used in the creation of the default string\n\t * description of an object. Called by the built-in method {@link Object.prototype.toString}.\n\t *\n\t * @returns The default string description of this object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'Subscription';\n\t}\n}", "import { SetMultiMap } from '@d1g1tal/collections/src';\nimport { ContextEventHandler } from './context-event-handler';\nimport { Subscription } from './subscription';\nimport type { ContextEventListener } from './@types';\n\n/** A class that allows objects to subscribe to events and be notified when the event is published. */\nexport class Subscribr {\n\tprivate readonly subscribers: SetMultiMap<string, ContextEventHandler>;\n\n\tconstructor() {\n\t\tthis.subscribers = new SetMultiMap();\n\t}\n\n\t/**\n\t * Subscribe to an event\n\t *\n\t * @param eventName The event name to subscribe to.\n\t * @param eventHandler The event handler to call when the event is published.\n\t * @param context The context to bind to the event handler.\n\t * @returns An object used to check if the subscription still exists and to unsubscribe from the event.\n\t */\n\tsubscribe(eventName: string, eventHandler: ContextEventListener, context: unknown = eventHandler): Subscription {\n\t\tconst contextEventHandler = new ContextEventHandler(context, eventHandler);\n\t\tthis.subscribers.set(eventName, contextEventHandler);\n\n\t\treturn new Subscription(eventName, contextEventHandler);\n\t}\n\n\t/**\n\t * Unsubscribe from the event\n\t *\n\t * @param subscription The subscription to unsubscribe.\n\t * @returns true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.\n\t */\n\tunsubscribe({ eventName, contextEventHandler }: Subscription): boolean {\n\t\tconst contextEventHandlers = this.subscribers.get(eventName) ?? new Set();\n\t\tconst removed = contextEventHandlers.delete(contextEventHandler);\n\n\t\tif (removed && contextEventHandlers.size === 0) {\tthis.subscribers.delete(eventName) }\n\n\t\treturn removed;\n\t}\n\n\t/**\n\t * Publish an event\n\t *\n\t * @template T\n\t * @param eventName The name of the event.\n\t * @param event The event to be handled.\n\t * @param data The value to be passed to the event handler as a parameter.\n\t */\n\tpublish<T>(eventName: string, event: Event = new CustomEvent(eventName), data?: T): void {\n\t\tthis.subscribers.get(eventName)?.forEach((contextEventHandler: ContextEventHandler) => contextEventHandler.handle(event, data));\n\t}\n\n\t/**\n\t * Check if the event and handler are subscribed.\n\t *\n\t * @param subscription The subscription object.\n\t * @returns true if the event name and handler are subscribed, false otherwise.\n\t */\n\tisSubscribed({ eventName, contextEventHandler }: Subscription): boolean {\n\t\treturn this.subscribers.get(eventName)?.has(contextEventHandler) ?? false;\n\t}\n\n\t/**\n\t * A String value that is used in the creation of the default string\n\t * description of an object. Called by the built-in method {@link Object.prototype.toString}.\n\t *\n\t * @returns The default string description of this object.\n\t */\n\tget [Symbol.toStringTag](): string {\n\t\treturn 'Subscribr';\n\t}\n}"],
+  "mappings": "AACO,IAAMA,EAAN,cAAgC,GAAc,CAW3C,IAAIC,EAAQC,EAA6B,CACjD,aAAM,IAAID,GAAM,MAAM,IAAIA,CAAG,GAAK,IAAI,KAAO,IAAIC,CAAK,CAAC,EAEhD,IACR,CASA,SAASD,EAAQC,EAAmB,CACnC,IAAMC,EAAS,MAAM,IAAIF,CAAG,EAE5B,OAAOE,EAASA,EAAO,IAAID,CAAK,EAAI,EACrC,CAEA,KAAKD,EAAQG,EAAgD,CAC5D,IAAMD,EAAS,KAAK,IAAIF,CAAG,EAE3B,GAAIE,IAAW,OACd,OAAO,MAAM,KAAKA,CAAM,EAAE,KAAKC,CAAQ,CAIzC,CASA,YAAYH,EAAQC,EAA+B,CAClD,GAAIA,IAAU,OAAa,OAAO,KAAK,OAAOD,CAAG,EAEjD,IAAME,EAAS,MAAM,IAAIF,CAAG,EAC5B,GAAIE,EAAQ,CACX,IAAME,EAAUF,EAAO,OAAOD,CAAK,EAEnC,OAAIC,EAAO,OAAS,GACnB,MAAM,OAAOF,CAAG,EAGVI,CACR,CAEA,MAAO,EACR,CAEA,IAAc,OAAO,WAAW,GAAY,CAC3C,MAAO,aACR,CACD,ECjEO,IAAMC,EAAN,KAA0B,CACf,QACA,cAMjB,YAAYC,EAAkBC,EAAqC,CAClE,KAAK,QAAUD,EACf,KAAK,cAAgBC,CACtB,CAQA,OAAOC,EAAcC,EAAsB,CAC1C,KAAK,cAAc,KAAK,KAAK,QAASD,EAAOC,CAAI,CAClD,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,qBACR,CACD,EChCO,IAAMC,EAAN,KAAmB,CACR,WACA,qBAMjB,YAAYC,EAAmBC,EAA0C,CACxE,KAAK,WAAaD,EAClB,KAAK,qBAAuBC,CAC7B,CAOA,IAAI,WAAoB,CACvB,OAAO,KAAK,UACb,CAOA,IAAI,qBAA2C,CAC9C,OAAO,KAAK,oBACb,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,cACR,CACD,ECrCO,IAAMC,EAAN,KAAgB,CACL,YAEjB,aAAc,CACb,KAAK,YAAc,IAAIC,CACxB,CAUA,UAAUC,EAAmBC,EAAoCC,EAAmBD,EAA4B,CAC/G,IAAME,EAAsB,IAAIC,EAAoBF,EAASD,CAAY,EACzE,YAAK,YAAY,IAAID,EAAWG,CAAmB,EAE5C,IAAIE,EAAaL,EAAWG,CAAmB,CACvD,CAQA,YAAY,CAAE,UAAAH,EAAW,oBAAAG,CAAoB,EAA0B,CACtE,IAAMG,EAAuB,KAAK,YAAY,IAAIN,CAAS,GAAK,IAAI,IAC9DO,EAAUD,EAAqB,OAAOH,CAAmB,EAE/D,OAAII,GAAWD,EAAqB,OAAS,GAAK,KAAK,YAAY,OAAON,CAAS,EAE5EO,CACR,CAUA,QAAWP,EAAmBQ,EAAe,IAAI,YAAYR,CAAS,EAAGS,EAAgB,CACxF,KAAK,YAAY,IAAIT,CAAS,GAAG,QAASG,GAA6CA,EAAoB,OAAOK,EAAOC,CAAI,CAAC,CAC/H,CAQA,aAAa,CAAE,UAAAT,EAAW,oBAAAG,CAAoB,EAA0B,CACvE,OAAO,KAAK,YAAY,IAAIH,CAAS,GAAG,IAAIG,CAAmB,GAAK,EACrE,CAQA,IAAK,OAAO,WAAW,GAAY,CAClC,MAAO,WACR,CACD",
   "names": ["SetMultiMap", "key", "value", "values", "iterator", "deleted", "ContextEventHandler", "context", "eventListener", "event", "data", "Subscription", "eventName", "contextEventHandler", "Subscribr", "SetMultiMap", "eventName", "eventHandler", "context", "contextEventHandler", "ContextEventHandler", "Subscription", "contextEventHandlers", "removed", "event", "data"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d1g1tal/subscribr",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "JavaScript Publish/Subscribe Library",
   "author": "Jason DiMeo",
   "license": "ISC",
@@ -36,32 +36,25 @@
     "url": "git+https://github.com/D1g1talEntr0py/subscribr.git"
   },
   "dependencies": {
-    "@d1g1tal/collections": "^2.0.2"
+    "@d1g1tal/collections": "^2.0.3"
   },
   "devDependencies": {
     "@d1g1tal/chrysalis": "^2.5.0",
-    "@eslint/compat": "^1.3.1",
-    "@eslint/js": "^9.31.0",
-    "@types/node": "^24.0.15",
-    "@typescript-eslint/eslint-plugin": "^8.37.0",
-    "@typescript-eslint/parser": "^8.37.0",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/js": "^9.34.0",
+    "@types/node": "^24.3.1",
+    "@typescript-eslint/eslint-plugin": "^8.42.0",
+    "@typescript-eslint/parser": "^8.42.0",
     "@vitest/coverage-v8": "^3.2.4",
-    "eslint": "^9.31.0",
+    "eslint": "^9.34.0",
     "eslint-plugin-compat": "^6.0.2",
-    "eslint-plugin-jsdoc": "^51.4.1",
-    "globals": "^16.3.0",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.37.0",
+    "eslint-plugin-jsdoc": "^54.3.1",
+    "typescript-eslint": "^8.42.0",
     "vitest": "^3.2.4"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
-  "peerDependenciesMeta": {
-    "typescript": {
-      "optional": true
-    }
-  },
   "engines": {
     "node": ">=20.15.1"
   },
@@ -74,7 +67,8 @@
     "build:watch": "tsbuild --watch",
     "type-check": "tsbuild --typeCheck",
     "lint": "eslint ./src",
-    "test": "vitest run --coverage",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "test:watch": "vitest",
     "prepublish": "pnpm lint && pnpm test && pnpm -s build"
   }

package/src/context-event-handler.ts

@@ -6,8 +6,8 @@ export class ContextEventHandler {
 	private readonly eventListener: ContextEventListener;
 
 	/**
-	 * @param {unknown} context The context to bind to the event handler.
-	 * @param {ContextEventListener} eventListener The event handler to call when the event is published.
+	 * @param context The context to bind to the event handler.
+	 * @param eventListener The event handler to call when the event is published.
 	 */
 	constructor(context: unknown, eventListener: ContextEventListener) {
 		this.context = context;
@@ -17,8 +17,8 @@ export class ContextEventHandler {
 	/**
 	 * Call the event handler for the provided event.
 	 *
-	 * @param {Event} event The event to handle
-	 * @param {unknown?} [data] The value to be passed to the event handler as a parameter.
+	 * @param event The event to handle
+	 * @param data The value to be passed to the event handler as a parameter.
 	 */
 	handle(event: Event, data?: unknown): void {
 		this.eventListener.call(this.context, event, data);
@@ -28,7 +28,7 @@ export class ContextEventHandler {
 	 * A String value that is used in the creation of the default string
 	 * description of an object. Called by the built-in method {@link Object.prototype.toString}.
 	 *
-	 * @returns {string} The default string description of this object.
+	 * @returns The default string description of this object.
 	 */
 	get [Symbol.toStringTag](): string {
 		return 'ContextEventHandler';

package/src/subscribr.ts

@@ -3,12 +3,7 @@ import { ContextEventHandler } from './context-event-handler';
 import { Subscription } from './subscription';
 import type { ContextEventListener } from './@types';
 
-/**
- * A class that allows objects to subscribe to events and be notified when the event is published.
- *
- * @class
- * @exports Subscribr
- */
+/** A class that allows objects to subscribe to events and be notified when the event is published. */
 export class Subscribr {
 	private readonly subscribers: SetMultiMap<string, ContextEventHandler>;
 
@@ -19,10 +14,10 @@ export class Subscribr {
 	/**
 	 * Subscribe to an event
 	 *
-	 * @param {string} eventName The event name to subscribe to.
-	 * @param {ContextEventListener} eventHandler The event handler to call when the event is published.
-	 * @param {unknown} [context] The context to bind to the event handler.
-	 * @returns {Subscription} An object used to check if the subscription still exists and to unsubscribe from the event.
+	 * @param eventName The event name to subscribe to.
+	 * @param eventHandler The event handler to call when the event is published.
+	 * @param context The context to bind to the event handler.
+	 * @returns An object used to check if the subscription still exists and to unsubscribe from the event.
 	 */
 	subscribe(eventName: string, eventHandler: ContextEventListener, context: unknown = eventHandler): Subscription {
 		const contextEventHandler = new ContextEventHandler(context, eventHandler);
@@ -34,8 +29,8 @@ export class Subscribr {
 	/**
 	 * Unsubscribe from the event
 	 *
-	 * @param {Subscription} subscription The subscription to unsubscribe.
-	 * @returns {boolean} true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.
+	 * @param subscription The subscription to unsubscribe.
+	 * @returns true if eventListener has been removed successfully. false if the value is not found or if the value is not an object.
 	 */
 	unsubscribe({ eventName, contextEventHandler }: Subscription): boolean {
 		const contextEventHandlers = this.subscribers.get(eventName) ?? new Set();
@@ -50,9 +45,9 @@ export class Subscribr {
 	 * Publish an event
 	 *
 	 * @template T
-	 * @param {string} eventName The name of the event.
-	 * @param {Event} [event=new CustomEvent(eventName)] The event to be handled.
-	 * @param {T} [data] The value to be passed to the event handler as a parameter.
+	 * @param eventName The name of the event.
+	 * @param event The event to be handled.
+	 * @param data The value to be passed to the event handler as a parameter.
 	 */
 	publish<T>(eventName: string, event: Event = new CustomEvent(eventName), data?: T): void {
 		this.subscribers.get(eventName)?.forEach((contextEventHandler: ContextEventHandler) => contextEventHandler.handle(event, data));
@@ -61,8 +56,8 @@ export class Subscribr {
 	/**
 	 * Check if the event and handler are subscribed.
 	 *
-	 * @param {Subscription} subscription The subscription object.
-	 * @returns {boolean} true if the event name and handler are subscribed, false otherwise.
+	 * @param subscription The subscription object.
+	 * @returns true if the event name and handler are subscribed, false otherwise.
 	 */
 	isSubscribed({ eventName, contextEventHandler }: Subscription): boolean {
 		return this.subscribers.get(eventName)?.has(contextEventHandler) ?? false;
@@ -72,7 +67,7 @@ export class Subscribr {
 	 * A String value that is used in the creation of the default string
 	 * description of an object. Called by the built-in method {@link Object.prototype.toString}.
 	 *
-	 * @returns {string} The default string description of this object.
+	 * @returns The default string description of this object.
 	 */
 	get [Symbol.toStringTag](): string {
 		return 'Subscribr';

package/src/subscription.ts

@@ -6,8 +6,8 @@ export class Subscription {
 	private readonly _contextEventHandler: ContextEventHandler;
 
 	/**
-	 * @param {string} eventName The event name.
-	 * @param {ContextEventHandler} contextEventHandler Then context event handler.
+	 * @param eventName The event name.
+	 * @param contextEventHandler The context event handler.
 	 */
 	constructor(eventName: string, contextEventHandler: ContextEventHandler) {
 		this._eventName = eventName;
@@ -17,7 +17,7 @@ export class Subscription {
 	/**
 	 * Gets the event name for the subscription.
 	 *
-	 * @returns {string} The event name.
+	 * @returns The event name.
 	 */
 	get eventName(): string {
 		return this._eventName;
@@ -26,7 +26,7 @@ export class Subscription {
 	/**
 	 * Gets the context event handler.
 	 *
-	 * @returns {ContextEventHandler} The context event handler
+	 * @returns The context event handler
 	 */
 	get contextEventHandler(): ContextEventHandler {
 		return this._contextEventHandler;
@@ -36,7 +36,7 @@ export class Subscription {
 	 * A String value that is used in the creation of the default string
 	 * description of an object. Called by the built-in method {@link Object.prototype.toString}.
 	 *
-	 * @returns {string} The default string description of this object.
+	 * @returns The default string description of this object.
 	 */
 	get [Symbol.toStringTag](): string {
 		return 'Subscription';