@ceeblue/web-utils 3.2.1 → 4.0.0

package/dist/web-utils.d.ts

@@ -302,7 +302,7 @@ type Params = {
     /**
      * Optional query to add into the generated url of connection
      */
-    query?: Record<string, string>;
+    query?: URLSearchParams;
 };
 /**
  * Type of connection
@@ -349,6 +349,20 @@ declare namespace Connect {
  * See file LICENSE or go to https://spdx.org/licenses/AGPL-3.0-or-later.html for full license details.
  */
 
+type FilterOnKey<T> = T extends 'once' | 'on' ? never : T extends `on${infer R}` ? R : never;
+type CaseVariations<T extends string> = string extends T ? string : Lowercase<T> | Capitalize<T>;
+/**
+ * Extract all event keys from a class.
+ * @example
+ * class Logger extends EventEmitter {
+ *   onLog(log:string) { console.log(log); }
+ *   onClick(log:string) { console.log(log); }
+ * }
+ * type LoggerEvents = EventKeys<Logger>; // "log" | "click"
+ */
+type EventKeys<Keys> = keyof {
+    [K in keyof Keys as CaseVariations<FilterOnKey<K>>]: never;
+};
 /**
  * A advanced EventEmitter which allows to declare event as natural function in the inheriting children class,
  * function must start by `on` prefix to be recognized as an event.
@@ -402,7 +416,7 @@ declare class EventEmitter extends Loggable {
      * @param event Subscriber Function
      * @param options.signal Optional `AbortSignal` to stop this or multiple subscriptions in same time
      */
-    on(name: string, event: Function, options?: {
+    on(name: EventKeys<this>, event: Function, options?: {
         signal?: AbortSignal;
     }): void;
     /**
@@ -411,7 +425,7 @@ declare class EventEmitter extends Loggable {
      * @param event Subscriber Function
      * @param options.abortSignal Optional `AbortSignal` to stop this or multiple subscriptions in same time
      */
-    once(name: string, event: Function, options?: {
+    once(name: EventKeys<this>, event: Function, options?: {
         signal?: AbortSignal;
     }): void;
     /**
@@ -419,7 +433,7 @@ declare class EventEmitter extends Loggable {
      * @param name Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)
      * @param event Unsubscriber Function, must be the one passed to {@link on} or {@link once} subscription methods
      */
-    off(name: string, event: Function): void;
+    off(name: EventKeys<this>, event: Function): boolean;
     private _event;
 }
 
@@ -783,10 +797,11 @@ declare function objectFrom(value: any, params: {
 }): any;
 /**
  * Returns entries from something iterable, such as a Map, Set, or Array
+ * If value is null it returns an empty array
  * @param value iterable input
  * @returns An javascript object
  */
-declare function objectEntries(value: any): [string, any][];
+declare function objectEntries(value: any | null): [string, any][];
 /**
  * Converts various data types, such as objects, strings, exceptions, errors,
  * or numbers, into a string representation. Since it offers a more comprehensive format,

package/dist/web-utils.js

@@ -258,10 +258,14 @@ function objectFrom(value, params) {
 }
 /**
  * Returns entries from something iterable, such as a Map, Set, or Array
+ * If value is null it returns an empty array
  * @param value iterable input
  * @returns An javascript object
  */
 function objectEntries(value) {
+    if (!value) {
+        return [];
+    }
     if (value.entries) {
         return value.entries();
     }
@@ -1222,8 +1226,8 @@ function buildURL(type, params, protocol = 'wss') {
     if (params.accessToken) {
         url.searchParams.set('id', params.accessToken);
     }
-    for (const key in params.query) {
-        url.searchParams.set(key, params.query[key]);
+    for (const [key, value] of objectEntries(params.query)) {
+        url.searchParams.set(key, value);
     }
     return url;
 }var Connect=/*#__PURE__*/Object.freeze({__proto__:null,get Type(){return Type},buildURL:buildURL,defineMediaExt:defineMediaExt});/**
@@ -1286,19 +1290,18 @@ class EventEmitter extends Loggable {
                 if (name.length < 3 || !name.startsWith('on')) {
                     continue;
                 }
-                if (proto[name] instanceof Function) {
+                let defaultEvent = proto[name];
+                if (defaultEvent instanceof Function) {
                     const events = new Set();
                     this._events.set(name.substring(2).toLowerCase(), events);
-                    let defaultEvent = proto[name];
                     const raise = (...args) => {
-                        // Call default event if not null (can happen in JS usage)
-                        if (defaultEvent) {
-                            defaultEvent.call(this, ...args);
-                        }
+                        // Call default event if not undefined, can happen if assigned to null/undefined
+                        const result = defaultEvent ? defaultEvent.call(this, ...args) : undefined;
                         // Call subscribers
                         for (const event of events) {
                             event(...args);
                         }
+                        return result;
                     };
                     Object.defineProperties(this, {
                         [name]: {
@@ -1322,8 +1325,8 @@ class EventEmitter extends Loggable {
      */
     on(name, event, options) {
         var _a;
-        if (!event) {
-            throw Error('event to subscribe cannot be null');
+        if (typeof event !== 'function') {
+            throw Error('event callback must be a function');
         }
         const events = this._event(name);
         events.add(event);
@@ -1337,8 +1340,8 @@ class EventEmitter extends Loggable {
      */
     once(name, event, options) {
         var _a;
-        if (!event) {
-            throw Error('event to subscribe cannot be null');
+        if (typeof event !== 'function') {
+            throw Error('event callback must be a function');
         }
         const events = this._event(name);
         events.add((...args) => {
@@ -1356,7 +1359,7 @@ class EventEmitter extends Loggable {
         if (!event) {
             throw Error('event to unsubscribe cannot be null');
         }
-        this._event(name).delete(event);
+        return this._event(name).delete(event);
     }
     _event(name) {
         const events = this._events.get(name.toLowerCase());
@@ -2416,4 +2419,4 @@ class UIMetrics {
  * This file is part of https://github.com/CeeblueTV/web-utils which is released under GNU Affero General Public License.
  * See file LICENSE or go to https://spdx.org/licenses/AGPL-3.0-or-later.html for full license details.
  */
-const VERSION = '3.2.1';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EpochTime,EventEmitter,FixMap,Log,LogLevel,Loggable,NetAddress,Numbers,Queue,SDP,UIMetrics,Util,VERSION,WebSocketReliable,log};//# sourceMappingURL=web-utils.js.map
+const VERSION = '4.0.0';export{BinaryReader,BinaryWriter,BitReader,ByteRate,Connect,EpochTime,EventEmitter,FixMap,Log,LogLevel,Loggable,NetAddress,Numbers,Queue,SDP,UIMetrics,Util,VERSION,WebSocketReliable,log};//# sourceMappingURL=web-utils.js.map