mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-19 15:33:12 +09:00
Move TypedEventEmitter into its own file
This commit is contained in:
1 parent
001db4befe
commit
7bbb44d4e6
4 files changed
+30
-11
No files matched your search
@@ -14,3 +14,4 @@ export * from "./src/subscriptions";
|
|||||||
|
|
||||||
export { default as ExponentialBackoff } from "./src/ExponentialBackoff";
|
export { default as ExponentialBackoff } from "./src/ExponentialBackoff";
|
||||||
export { default as RateLimiter } from "./src/RateLimiter";
|
export { default as RateLimiter } from "./src/RateLimiter";
|
||||||
|
export { default as TypedEventEmitter } from "./src/TypedEventEmitter";
|
||||||
@@ -31,3 +31,4 @@ export * from "./src/subscriptions";
|
|||||||
export { default as ExponentialBackoff } from "./src/ExponentialBackoff";
|
export { default as ExponentialBackoff } from "./src/ExponentialBackoff";
|
||||||
export { default as ModStore } from "./src/ModStore";
|
export { default as ModStore } from "./src/ModStore";
|
||||||
export { default as RateLimiter } from "./src/RateLimiter";
|
export { default as RateLimiter } from "./src/RateLimiter";
|
||||||
|
export { default as TypedEventEmitter } from "./src/TypedEventEmitter";
|
||||||
@@ -2,17 +2,7 @@ import fs from "fs-extra";
|
|||||||
import path from "path";
|
import path from "path";
|
||||||
import { logger } from "./logging";
|
import { logger } from "./logging";
|
||||||
import { ModInfo } from "./data";
|
import { ModInfo } from "./data";
|
||||||
import EventEmitter from "events";
|
import TypedEventEmitter from "./TypedEventEmitter";
|
||||||
|
|
||||||
abstract class TypedEventEmitter<
|
|
||||||
Keys extends string,
|
|
||||||
Events extends Record<Keys, (...args: [...any]) => void>,
|
|
||||||
> extends EventEmitter {
|
|
||||||
declare ["on"]: <E extends Keys>(event: E, listener: Events[E]) => this;
|
|
||||||
declare ["off"]: <E extends Keys>(event: E, listener: Events[E]) => this;
|
|
||||||
declare ["once"]: <E extends Keys>(event: E, listener: Events[E]) => this;
|
|
||||||
declare ["emit"]: <E extends Keys>(event: E, ...args: Parameters<Events[E]>) => boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ModStoreEvents {
|
export interface ModStoreEvents {
|
||||||
/** A stored mod was created, updated or deleted */
|
/** A stored mod was created, updated or deleted */
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
import EventEmitter from "events";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Type checked version of EventEmitter
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```ts
|
||||||
|
* interface Events {
|
||||||
|
* "foo": (a: number, b: number) => void,
|
||||||
|
* "bar": (spam: string) => void,
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* class Emitter extends TypedEventEmitter<keyof Events, Events> {}
|
||||||
|
*
|
||||||
|
* const e = new Emitter();
|
||||||
|
* e.emit("foo", 1, 2) // type checked arguments
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
export default abstract class TypedEventEmitter<
|
||||||
|
Keys extends string,
|
||||||
|
Events extends Record<Keys, (...args: [...any]) => void>,
|
||||||
|
> extends EventEmitter {
|
||||||
|
declare ["on"]: <E extends Keys>(event: E, listener: Events[E]) => this;
|
||||||
|
declare ["off"]: <E extends Keys>(event: E, listener: Events[E]) => this;
|
||||||
|
declare ["once"]: <E extends Keys>(event: E, listener: Events[E]) => this;
|
||||||
|
declare ["emit"]: <E extends Keys>(event: E, ...args: Parameters<Events[E]>) => boolean;
|
||||||
|
}
|
||||||
Reference in new issue
Block a user