@thi.ng/api 8.4.6 → 8.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-11-23T22:46:54Z
+- **Last updated**: 2022-11-28T13:36:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [8.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/api@8.5.0) (2022-11-28)
+
+#### 🚀 Features
+
+- add boolean result for INotifiy.notify(), update mixin ([f4cb33a](https://github.com/thi-ng/umbrella/commit/f4cb33a))
+
 ### [8.4.5](https://github.com/thi-ng/umbrella/tree/@thi.ng/api@8.4.5) (2022-11-01)
 
 #### 🩹 Bug fixes

package/README.md

@@ -60,7 +60,7 @@ node --experimental-repl-await
 > const api = await import("@thi.ng/api");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 2.33 KB
+Package sizes (gzipped, pre-treeshake): ESM: 2.34 KB
 
 ## Dependencies
 

package/event.d.ts

@@ -16,6 +16,19 @@ export interface Event extends IID<PropertyKey> {
 export interface INotify {
     addListener(id: string, fn: Listener, scope?: any): boolean;
     removeListener(id: string, fn: Listener, scope?: any): boolean;
-    notify(event: Event): void;
+    /**
+     * Broadcasts all registered listeners for given event type (in order
+     * registration) and returns true if any of them have been successfully
+     * notified.
+     *
+     * @remarks
+     * If a listener canceled the event (by setting {@link Event.canceled}), the
+     * function will stop notifying other listeners and return false. If no
+     * listeners are registered for the event, the function will also return
+     * false.
+     *
+     * @param event
+     */
+    notify(event: Event): boolean;
 }
 //# sourceMappingURL=event.d.ts.map

package/mixins/inotify.d.ts

@@ -1,5 +1,5 @@
 import type { Event } from "../event.js";
-export declare const inotify_dispatch: (listeners: any[][], e: Event) => void;
+export declare const inotify_dispatch: (listeners: any[][], e: Event) => boolean;
 /**
  * Mixin class decorator, injects INotify default implementation, incl.
  * a lazily instantiated `_listeners` property object, storing

package/mixins/inotify.js

@@ -2,14 +2,15 @@ import { EVENT_ALL } from "../api.js";
 import { mixin } from "../mixin.js";
 export const inotify_dispatch = (listeners, e) => {
     if (!listeners)
-        return;
+        return false;
     for (let i = 0, n = listeners.length, l; i < n; i++) {
         l = listeners[i];
         l[0].call(l[1], e);
         if (e.canceled) {
-            return;
+            return false;
         }
     }
+    return true;
 };
 /**
  * Mixin class decorator, injects INotify default implementation, incl.
@@ -46,8 +47,8 @@ export const INotifyMixin = mixin({
         if (!(listeners = this._listeners))
             return false;
         e.target === undefined && (e.target = this);
-        inotify_dispatch(listeners[e.id], e);
-        inotify_dispatch(listeners[EVENT_ALL], e);
+        const res = inotify_dispatch(listeners[e.id], e);
+        return inotify_dispatch(listeners[EVENT_ALL], e) || res;
     },
     __listener(listeners, f, scope) {
         let i = listeners.length;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/api",
-  "version": "8.4.6",
+  "version": "8.5.0",
   "description": "Common, generic types, interfaces & mixins",
   "type": "module",
   "module": "./index.js",
@@ -222,5 +222,5 @@
       "default": "./watch.js"
     }
   },
-  "gitHead": "044ee6a3895720fc78e115032d4d831b63510929\n"
+  "gitHead": "75ec32ff7f1b7b5e72e7a04ace24732cd5d6c774\n"
 }