@open-pioneer/core 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/events.d.ts +2 -2
- package/events.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/events.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Resource } from "./resources";
|
|
2
2
|
declare const state: unique symbol;
|
|
3
|
-
export type EventNames<Events extends
|
|
3
|
+
export type EventNames<Events extends {}> = keyof Events & string;
|
|
4
4
|
type ArgType<T> = [T] extends [void] ? [] : [event: T];
|
|
5
|
-
type EventType<Events extends
|
|
5
|
+
type EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Name]>;
|
|
6
6
|
/**
|
|
7
7
|
* A support class that implements emitting and listening for events.
|
|
8
8
|
*
|
package/events.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource } from \"./resources\";\n\nconst state = Symbol(\"EventEmitterState\");\n\nexport type EventNames<Events extends
|
|
1
|
+
{"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: con terra GmbH and contributors\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource } from \"./resources\";\n\nconst state = Symbol(\"EventEmitterState\");\n\nexport type EventNames<Events extends {}> = keyof Events & string;\n\ntype ArgType<T> = [T] extends [void] ? [] : [event: T];\n\ntype EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Name]>;\n\n/**\n * A support class that implements emitting and listening for events.\n *\n * This class supports inheritance or direct use:\n *\n * ```js\n * const emitter = new EventEmitter();\n * class MyClass extends EventEmitter {};\n * ```\n *\n * When using this class from TypeScript, declare your supported event\n * types using an interface first:\n *\n * ```ts\n * interface Events {\n * // key: event name, value: event type\n * \"mouse-clicked\": MouseEvent;\n * }\n *\n * const emitter = new EventEmitter<Events>();\n * emitter.on(\"mouse-clicked\", (event) => {\n * // event is a MouseEvent\n * });\n * emitter.emit(\"mouse-clicked\", new MouseEvent(...));\n * ```\n */\nexport class EventEmitter<Events extends {}> {\n private [state] = new EventEmitterState();\n\n /**\n * Registers the given listener function as an event handler for `eventName`.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}\n * when it is no longer needed.\n */\n on<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener\n });\n }\n\n /**\n * Registers the given listener function to listen for `eventName` events _once_.\n * The listener function will automatically be unregistered after it has been called.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}.\n */\n once<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener,\n once: true\n });\n }\n\n /**\n * Emits an event of the given name and calls the registered event handlers.\n *\n * _Note:_ event handlers run synchronously.\n * After `emit()` has completed, all listeners will already have been invoked.\n */\n emit<Name extends EventNames<Events>>(eventName: Name, ...args: EventType<Events, Name>): void {\n this[state].emit(eventName, args[0]);\n }\n}\n\n/**\n * Read-only version of the {@link EventEmitter} interface that only allows listening for events.\n */\nexport type EventSource<Events extends {}> = Pick<EventEmitter<Events>, \"on\" | \"once\">;\n\ntype InternalListener = (event: unknown) => void;\n\ninterface EventHandler {\n once?: boolean;\n removed?: boolean;\n listener: InternalListener;\n}\n\nclass EventEmitterState {\n private handlers = new Map<string, Set<EventHandler>>();\n\n on(name: string, handler: EventHandler): Resource {\n let handlers = this.handlers.get(name);\n if (!handlers) {\n handlers = new Set();\n this.handlers.set(name, handlers);\n }\n handlers.add(handler);\n return {\n destroy() {\n handler.removed = true;\n handlers?.delete(handler);\n handlers = undefined;\n }\n };\n }\n\n emit(name: string, event: unknown) {\n const handlers = this.handlers.get(name);\n if (!handlers) {\n return;\n }\n\n // Copy to allow (de-) registration of handlers during emit.\n // This is convenient for correctness but may been further optimization\n // if events are emitted frequently.\n const copy = [...handlers];\n for (const handler of copy) {\n if (handler.removed) {\n continue;\n }\n\n if (handler.once) {\n handler.removed = true;\n handlers.delete(handler);\n }\n handler.listener(event);\n }\n }\n}\n"],"names":[],"mappings":"AAIA,MAAM,KAAA,GAAQ,OAAO,mBAAmB,CAAA,CAAA;AAkCjC,MAAM,YAAgC,CAAA;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAkB,EAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,EAAA,CACI,WACA,QACQ,EAAA;AACR,IAAA,OAAO,IAAK,CAAA,KAAK,CAAE,CAAA,EAAA,CAAG,SAAW,EAAA;AAAA,MAC7B,QAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CACI,WACA,QACQ,EAAA;AACR,IAAA,OAAO,IAAK,CAAA,KAAK,CAAE,CAAA,EAAA,CAAG,SAAW,EAAA;AAAA,MAC7B,QAAA;AAAA,MACA,IAAM,EAAA,IAAA;AAAA,KACT,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAsC,cAAoB,IAAqC,EAAA;AAC3F,IAAA,IAAA,CAAK,KAAK,CAAE,CAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,CAAC,CAAC,CAAA,CAAA;AAAA,GACvC;AACJ,CAAA;AAeA,MAAM,iBAAkB,CAAA;AAAA,EACZ,QAAA,uBAAe,GAA+B,EAAA,CAAA;AAAA,EAEtD,EAAA,CAAG,MAAc,OAAiC,EAAA;AAC9C,IAAA,IAAI,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AACrC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,QAAA,uBAAe,GAAI,EAAA,CAAA;AACnB,MAAK,IAAA,CAAA,QAAA,CAAS,GAAI,CAAA,IAAA,EAAM,QAAQ,CAAA,CAAA;AAAA,KACpC;AACA,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA,CAAA;AACpB,IAAO,OAAA;AAAA,MACH,OAAU,GAAA;AACN,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA,CAAA;AAClB,QAAA,QAAA,EAAU,OAAO,OAAO,CAAA,CAAA;AACxB,QAAW,QAAA,GAAA,KAAA,CAAA,CAAA;AAAA,OACf;AAAA,KACJ,CAAA;AAAA,GACJ;AAAA,EAEA,IAAA,CAAK,MAAc,KAAgB,EAAA;AAC/B,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AACvC,IAAA,IAAI,CAAC,QAAU,EAAA;AACX,MAAA,OAAA;AAAA,KACJ;AAKA,IAAM,MAAA,IAAA,GAAO,CAAC,GAAG,QAAQ,CAAA,CAAA;AACzB,IAAA,KAAA,MAAW,WAAW,IAAM,EAAA;AACxB,MAAA,IAAI,QAAQ,OAAS,EAAA;AACjB,QAAA,SAAA;AAAA,OACJ;AAEA,MAAA,IAAI,QAAQ,IAAM,EAAA;AACd,QAAA,OAAA,CAAQ,OAAU,GAAA,IAAA,CAAA;AAClB,QAAA,QAAA,CAAS,OAAO,OAAO,CAAA,CAAA;AAAA,OAC3B;AACA,MAAA,OAAA,CAAQ,SAAS,KAAK,CAAA,CAAA;AAAA,KAC1B;AAAA,GACJ;AACJ;;;;"}
|