grofc_utils 1.6.1 → 1.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grofc_utils",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/event.js

@@ -1,4 +1,4 @@
-import { isPlainObject, throwIfIsNotExpectedValue, throwIfIsNotFunction, throwIfIsNotPlainObject, throwIfIsNotString } from "./guard.js"
+import { isPlainObject, throwIfIsNotExpectedValue, throwIfIsNotFunction, throwIfIsNotPlainObject, throwIfIsNotString, throwIfSomeKeysMissing } from "./guard.js"
 import { assignWithDescriptors } from "./object.js";
 import { randomString } from "./random.js";
 
@@ -15,18 +15,43 @@ import { randomString } from "./random.js";
  *  )=>object
  *  on:(event:string,phase:"before"|"begin"|"end"|"after",{
  *      name:string
- *      filter:(event:{
+ *      filter?:(event:{
  *          target,name:string,type:string|null,preData:object,data:object
  *      })
  *      callback:(event:{
  *          target,name:string,type:string|null,preData:object,data:object
  *      })=>void
+ *      once?:boolean
  *  })=>void
  *  off:(event:string,phase:"before"|"begin"|"end"|"after",name:string)=>void
  * }} 包含dispatchSync, on, off方法的对象
  */
 export function createEventEmitter() {
     const listenerMap = new Map()
+    const on = (event, phase, listener = {}) => {
+        throwIfIsNotString(event, "event");
+        throwIfIsNotExpectedValue(phase, "phase", "before", "begin", "end", "after");
+        throwIfSomeKeysMissing(listener, ["name", "callback"], "listener")
+        const eventName = event + ":" + phase;
+        const listenerList = listenerMap.get(eventName)
+        if (Array.isArray(listenerList)) {
+            listenerList.push(listener)
+        } else {
+            listenerMap.set(eventName, [listener]);
+        }
+    }
+    const off = (event, phase, name) => {
+        throwIfIsNotString(event, "event");
+        throwIfIsNotExpectedValue(phase, "phase", "before", "begin", "end", "after");
+        throwIfIsNotString(name, "name")
+        const eventName = event + ":" + phase;
+        const list = listenerMap.get(eventName);
+        if (Array.isArray(list)) {
+            const index = list.findIndex(o => o.name === name)
+            if (index !== -1) list.splice(index, 1);
+            if (list.length === 0) listenerMap.delete(eventName);
+        }
+    };
     const dispatchSync = (event, ing = () => { }, options = {}) => {
         throwIfIsNotString(event, "event");
         throwIfIsNotFunction(ing, "ing");
@@ -63,9 +88,11 @@ export function createEventEmitter() {
             }
         }, baseEvent)
         const beforeListenerList = listenerMap.get(event + ":before") ?? [];
-        for (const { filter, callback } of beforeListenerList) {
+        for (const { name, filter, callback, once } of beforeListenerList.slice()) {
             if (filter?.(beforeEvent) === false) continue;
-            if (callback(beforeEvent) === false && beforeEvent.status.cancellable) return;
+            const toCancel = callback(beforeEvent);
+            if (once) off(event, "before", name)
+            if (toCancel === false && beforeEvent.status.cancellable) return;
         }
         // 触发begin阶段监听器
         const beginEvent = assignWithDescriptors({
@@ -74,9 +101,10 @@ export function createEventEmitter() {
             }
         }, baseEvent);
         const beginListenerList = listenerMap.get(event + ":begin") ?? [];
-        for (const { callback, filter } of beginListenerList) {
+        for (const { name, callback, filter, once } of beginListenerList.slice()) {
             if (filter?.(beginEvent) === false) continue;
             callback(beginEvent)
+            if (once) off(event, "begin", name)
         }
         // 执行ing阶段函数并获取当前数据
         const ingEvent = assignWithDescriptors({
@@ -96,9 +124,10 @@ export function createEventEmitter() {
             }
         }, baseEvent)
         const endListenerList = listenerMap.get(event + ":end") ?? []
-        for (const { callback, filter } of endListenerList) {
+        for (const { name, callback, filter, once } of endListenerList.slice()) {
             if (filter?.(endEvent) === false) continue;
             callback(endEvent)
+            if (once) off(event, "end", name)
         }
         // 触发after阶段监听器，并处理可能的递归事件调用
         const afterEvent = assignWithDescriptors({
@@ -110,37 +139,17 @@ export function createEventEmitter() {
             }
         }, baseEvent);
         const afterListenerList = listenerMap.get(event + ":after") ?? [];
-        for (const { callback, filter } of afterListenerList) {
+        for (const { name, callback, filter, once } of afterListenerList.slice()) {
             if (filter?.(afterEvent) === false) continue;
             const result = callback(afterEvent)
+            if (once) off(event, "after", name)
             if (!isPlainObject(result)) continue;
             const { event, ing, options } = result;
             if (typeof event !== "string") continue;
             dispatchSync(event, ing, options)
         }
     }
-    const on = (event, phase, listener = {}) => {
-        throwIfIsNotString(event, "event");
-        throwIfIsNotExpectedValue(phase, "phase", "before", "begin", "end", "after");
-        const eventName = event + ":" + phase;
-        const listenerList = listenerMap.get(eventName)
-        if (Array.isArray(listenerList)) {
-            listenerList.push(listener)
-        } else {
-            listenerMap.set(eventName, [listener]);
-        }
-    }
-    const off = (event, phase, name) => {
-        throwIfIsNotString(event, "event");
-        throwIfIsNotExpectedValue(phase, "phase", "before", "begin", "end", "after");
-        const eventName = event + ":" + phase;
-        const list = listenerMap.get(eventName);
-        if (Array.isArray(list)) {
-            const index = list.findIndex(o => o.name === name)
-            if (index !== -1) list.splice(index, 1);
-            if (list.length === 0) listenerMap.delete(eventName);
-        }
-    };
+
     return {
         dispatchSync,
         on,