@eggjs/eventbus-decorator 4.0.0-beta.3 → 4.0.0-beta.5
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/README.md +12 -0
- package/dist/Event.d.ts +7 -0
- package/dist/Event.js +15 -0
- package/dist/EventBus.d.ts +49 -0
- package/dist/EventBus.js +5 -0
- package/dist/EventContext.d.ts +9 -0
- package/dist/EventContext.js +15 -0
- package/dist/EventInfoUtil.d.ts +23 -0
- package/dist/EventInfoUtil.js +36 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +6 -0
- package/dist/typed-emitter.d.ts +39 -0
- package/package.json +25 -26
- package/src/Event.d.ts +0 -3
- package/src/Event.js +0 -14
- package/src/EventBus.d.ts +0 -46
- package/src/EventBus.js +0 -2
- package/src/EventContext.d.ts +0 -5
- package/src/EventContext.js +0 -11
- package/src/EventInfoUtil.d.ts +0 -19
- package/src/EventInfoUtil.js +0 -36
- package/src/index.d.ts +0 -6
- package/src/index.js +0 -5
- package/src/type.d.ts +0 -6
- package/src/typed-emitter.d.ts +0 -36
- package/src/typed-emitter.js +0 -4
package/README.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# `@eggjs/eventbus-decorator`
|
|
2
2
|
|
|
3
|
+
[![NPM version][npm-image]][npm-url]
|
|
4
|
+
[![Known Vulnerabilities][snyk-image]][snyk-url]
|
|
5
|
+
[![npm download][download-image]][download-url]
|
|
6
|
+
[](https://nodejs.org/en/download/)
|
|
7
|
+
|
|
8
|
+
[npm-image]: https://img.shields.io/npm/v/@eggjs/eventbus-decorator.svg?style=flat-square
|
|
9
|
+
[npm-url]: https://npmjs.org/package/@eggjs/eventbus-decorator
|
|
10
|
+
[snyk-image]: https://snyk.io/test/npm/@eggjs/eventbus-decorator/badge.svg?style=flat-square
|
|
11
|
+
[snyk-url]: https://snyk.io/test/npm/@eggjs/eventbus-decorator
|
|
12
|
+
[download-image]: https://img.shields.io/npm/dm/@eggjs/eventbus-decorator.svg?style=flat-square
|
|
13
|
+
[download-url]: https://npmjs.org/package/@eggjs/eventbus-decorator
|
|
14
|
+
|
|
3
15
|
## Usage
|
|
4
16
|
|
|
5
17
|
### emit event
|
package/dist/Event.d.ts
ADDED
package/dist/Event.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { EventInfoUtil } from "./EventInfoUtil.js";
|
|
2
|
+
import { AccessLevel, PrototypeUtil, SingletonProto } from "@eggjs/core-decorator";
|
|
3
|
+
import { StackUtil } from "@eggjs/tegg-common-util";
|
|
4
|
+
|
|
5
|
+
//#region src/Event.ts
|
|
6
|
+
function Event(eventName) {
|
|
7
|
+
return function(clazz) {
|
|
8
|
+
EventInfoUtil.addEventName(eventName, clazz);
|
|
9
|
+
SingletonProto({ accessLevel: AccessLevel.PUBLIC })(clazz);
|
|
10
|
+
PrototypeUtil.setFilePath(clazz, StackUtil.getCalleeFromStack(false, 5));
|
|
11
|
+
};
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
//#endregion
|
|
15
|
+
export { Event };
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { Events } from "./Event.js";
|
|
2
|
+
import { IEventContext } from "./EventContext.js";
|
|
3
|
+
import { Arguments, TypedEventEmitter } from "./typed-emitter.js";
|
|
4
|
+
|
|
5
|
+
//#region src/EventBus.d.ts
|
|
6
|
+
type EventName = string | symbol;
|
|
7
|
+
/**
|
|
8
|
+
* use `emit` to emit a event
|
|
9
|
+
*/
|
|
10
|
+
interface EventBus extends Pick<TypedEventEmitter<Events>, 'emit'> {
|
|
11
|
+
cork(corkId: string): void;
|
|
12
|
+
/**
|
|
13
|
+
* @return true if uncorked
|
|
14
|
+
*/
|
|
15
|
+
uncork(corkId: string): boolean;
|
|
16
|
+
}
|
|
17
|
+
declare const CORK_ID: unique symbol;
|
|
18
|
+
interface ContextEventBus extends EventBus {
|
|
19
|
+
cork(): void;
|
|
20
|
+
uncork(): boolean;
|
|
21
|
+
}
|
|
22
|
+
type EventKeys = keyof Events;
|
|
23
|
+
/**
|
|
24
|
+
* use to ensure event will happen
|
|
25
|
+
* Can not inject for now, only use for unittest
|
|
26
|
+
*/
|
|
27
|
+
interface EventWaiter {
|
|
28
|
+
await<E extends keyof Events>(event: E): Promise<Arguments<Events[E]>>;
|
|
29
|
+
awaitFirst<E1 extends EventKeys, E2 extends EventKeys>(e1: E1, e2: E2): Promise<{
|
|
30
|
+
event: E1 | E2;
|
|
31
|
+
args: Arguments<Events[E1] | Events[E2]>;
|
|
32
|
+
}>;
|
|
33
|
+
awaitFirst<E1 extends EventKeys, E2 extends EventKeys, E3 extends EventKeys>(e1: E1, e2: E2, e3: E3): Promise<{
|
|
34
|
+
event: E1 | E2 | E3;
|
|
35
|
+
args: Arguments<Events[E1] | Events[E2] | Events[E3]>;
|
|
36
|
+
}>;
|
|
37
|
+
awaitFirst<E1 extends EventKeys, E2 extends EventKeys, E3 extends EventKeys, E4 extends EventKeys>(e1: E1, e2: E2, e3: E3, e4: E4): Promise<{
|
|
38
|
+
event: E1 | E2 | E3 | E4;
|
|
39
|
+
args: Arguments<Events[E1] | Events[E2] | Events[E3] | Events[E4]>;
|
|
40
|
+
}>;
|
|
41
|
+
}
|
|
42
|
+
type EventHandlerWithContext<E extends keyof Events> = {
|
|
43
|
+
handle: (ctx: IEventContext, ...args: Arguments<Events[E]>) => ReturnType<Events[E]>;
|
|
44
|
+
};
|
|
45
|
+
type EventHandler<E extends keyof Events> = {
|
|
46
|
+
handle: Events[E];
|
|
47
|
+
} | EventHandlerWithContext<E>;
|
|
48
|
+
//#endregion
|
|
49
|
+
export { CORK_ID, ContextEventBus, EventBus, EventHandler, EventKeys, EventName, EventWaiter };
|
package/dist/EventBus.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Events } from "./Event.js";
|
|
2
|
+
|
|
3
|
+
//#region src/EventContext.d.ts
|
|
4
|
+
interface IEventContext {
|
|
5
|
+
eventName: keyof Events;
|
|
6
|
+
}
|
|
7
|
+
declare function EventContext(): (target: any, propertyKey: PropertyKey, parameterIndex: number) => void;
|
|
8
|
+
//#endregion
|
|
9
|
+
export { EventContext, IEventContext };
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { EventInfoUtil } from "./EventInfoUtil.js";
|
|
2
|
+
import assert from "node:assert";
|
|
3
|
+
|
|
4
|
+
//#region src/EventContext.ts
|
|
5
|
+
function EventContext() {
|
|
6
|
+
return function(target, propertyKey, parameterIndex) {
|
|
7
|
+
assert(propertyKey === "handle", `[eventHandler ${target.name}] expect method name be handle, but now is ${String(propertyKey)}`);
|
|
8
|
+
assert(parameterIndex === 0, `[eventHandler ${target.name}] expect param EventContext be the first param`);
|
|
9
|
+
const clazz = target.constructor;
|
|
10
|
+
EventInfoUtil.setEventHandlerContextInject(true, clazz);
|
|
11
|
+
};
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
//#endregion
|
|
15
|
+
export { EventContext };
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { EventName } from "./EventBus.js";
|
|
2
|
+
import { EggProtoImplClass } from "@eggjs/tegg-types";
|
|
3
|
+
|
|
4
|
+
//#region src/EventInfoUtil.d.ts
|
|
5
|
+
declare const EVENT_NAME: unique symbol;
|
|
6
|
+
declare const EVENT_CONTEXT_INJECT: unique symbol;
|
|
7
|
+
declare class EventInfoUtil {
|
|
8
|
+
/**
|
|
9
|
+
* @deprecated
|
|
10
|
+
*/
|
|
11
|
+
static setEventName(eventName: EventName, clazz: EggProtoImplClass): void;
|
|
12
|
+
static addEventName(eventName: EventName, clazz: EggProtoImplClass): void;
|
|
13
|
+
static getEventNameList(clazz: EggProtoImplClass): EventName[];
|
|
14
|
+
/**
|
|
15
|
+
* @deprecated
|
|
16
|
+
* return the last eventName which is subscribed firstly by Event decorator
|
|
17
|
+
*/
|
|
18
|
+
static getEventName(clazz: EggProtoImplClass): EventName | undefined;
|
|
19
|
+
static setEventHandlerContextInject(enable: boolean, clazz: EggProtoImplClass): void;
|
|
20
|
+
static getEventHandlerContextInject(clazz: EggProtoImplClass): boolean;
|
|
21
|
+
}
|
|
22
|
+
//#endregion
|
|
23
|
+
export { EVENT_CONTEXT_INJECT, EVENT_NAME, EventInfoUtil };
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { MetadataUtil } from "@eggjs/core-decorator";
|
|
2
|
+
|
|
3
|
+
//#region src/EventInfoUtil.ts
|
|
4
|
+
const EVENT_NAME = Symbol.for("EggPrototype#eventName");
|
|
5
|
+
const EVENT_CONTEXT_INJECT = Symbol.for("EggPrototype#event#handler#context#inject");
|
|
6
|
+
var EventInfoUtil = class EventInfoUtil {
|
|
7
|
+
/**
|
|
8
|
+
* @deprecated
|
|
9
|
+
*/
|
|
10
|
+
static setEventName(eventName, clazz) {
|
|
11
|
+
EventInfoUtil.addEventName(eventName, clazz);
|
|
12
|
+
}
|
|
13
|
+
static addEventName(eventName, clazz) {
|
|
14
|
+
MetadataUtil.initOwnArrayMetaData(EVENT_NAME, clazz, []).push(eventName);
|
|
15
|
+
}
|
|
16
|
+
static getEventNameList(clazz) {
|
|
17
|
+
return MetadataUtil.getArrayMetaData(EVENT_NAME, clazz);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @deprecated
|
|
21
|
+
* return the last eventName which is subscribed firstly by Event decorator
|
|
22
|
+
*/
|
|
23
|
+
static getEventName(clazz) {
|
|
24
|
+
const eventNameList = MetadataUtil.initOwnArrayMetaData(EVENT_NAME, clazz, []);
|
|
25
|
+
if (eventNameList.length !== 0) return eventNameList[eventNameList.length - 1];
|
|
26
|
+
}
|
|
27
|
+
static setEventHandlerContextInject(enable, clazz) {
|
|
28
|
+
MetadataUtil.defineMetaData(EVENT_CONTEXT_INJECT, enable, clazz);
|
|
29
|
+
}
|
|
30
|
+
static getEventHandlerContextInject(clazz) {
|
|
31
|
+
return MetadataUtil.getMetaData(EVENT_CONTEXT_INJECT, clazz) ?? false;
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
//#endregion
|
|
36
|
+
export { EVENT_CONTEXT_INJECT, EVENT_NAME, EventInfoUtil };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { Event, Events } from "./Event.js";
|
|
2
|
+
import { EventContext, IEventContext } from "./EventContext.js";
|
|
3
|
+
import { Arguments } from "./typed-emitter.js";
|
|
4
|
+
import { CORK_ID, ContextEventBus, EventBus, EventHandler, EventKeys, EventName, EventWaiter } from "./EventBus.js";
|
|
5
|
+
import { EVENT_CONTEXT_INJECT, EVENT_NAME, EventInfoUtil } from "./EventInfoUtil.js";
|
|
6
|
+
export { Arguments, CORK_ID, ContextEventBus, EVENT_CONTEXT_INJECT, EVENT_NAME, Event, EventBus, EventContext, EventHandler, EventInfoUtil, EventKeys, EventName, EventWaiter, Events, IEventContext };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { CORK_ID } from "./EventBus.js";
|
|
2
|
+
import { EVENT_CONTEXT_INJECT, EVENT_NAME, EventInfoUtil } from "./EventInfoUtil.js";
|
|
3
|
+
import { Event } from "./Event.js";
|
|
4
|
+
import { EventContext } from "./EventContext.js";
|
|
5
|
+
|
|
6
|
+
export { CORK_ID, EVENT_CONTEXT_INJECT, EVENT_NAME, Event, EventContext, EventInfoUtil };
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
//#region src/typed-emitter.d.ts
|
|
2
|
+
type Arguments<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
|
|
3
|
+
/**
|
|
4
|
+
* Type-safe event emitter.
|
|
5
|
+
*
|
|
6
|
+
* Use it like this:
|
|
7
|
+
*
|
|
8
|
+
* interface MyEvents {
|
|
9
|
+
* error: (error: Error) => void
|
|
10
|
+
* message: (from: string, content: string) => void
|
|
11
|
+
* }
|
|
12
|
+
*
|
|
13
|
+
* const myEmitter = new EventEmitter() as TypedEmitter<MyEvents>
|
|
14
|
+
*
|
|
15
|
+
* myEmitter.on("message", (from, content) => {
|
|
16
|
+
* // ...
|
|
17
|
+
* })
|
|
18
|
+
*
|
|
19
|
+
* myEmitter.emit("error", "x") // <- Will catch this type error
|
|
20
|
+
*/
|
|
21
|
+
interface TypedEventEmitter<Events> {
|
|
22
|
+
addListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
23
|
+
on<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
24
|
+
once<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
25
|
+
prependListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
26
|
+
prependOnceListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
27
|
+
off<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
28
|
+
removeAllListeners<E extends keyof Events>(event?: E): this;
|
|
29
|
+
removeListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
30
|
+
emit<E extends keyof Events>(event: E, ...args: Arguments<Events[E]>): boolean;
|
|
31
|
+
eventNames(): (keyof Events | string | symbol)[];
|
|
32
|
+
rawListeners<E extends keyof Events>(event: E): Function[];
|
|
33
|
+
listeners<E extends keyof Events>(event: E): Function[];
|
|
34
|
+
listenerCount<E extends keyof Events>(event: E): number;
|
|
35
|
+
getMaxListeners(): number;
|
|
36
|
+
setMaxListeners(maxListeners: number): this;
|
|
37
|
+
}
|
|
38
|
+
//#endregion
|
|
39
|
+
export { Arguments, TypedEventEmitter };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eggjs/eventbus-decorator",
|
|
3
|
-
"version": "4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-beta.5",
|
|
4
4
|
"description": "tegg eventbus decorator",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"egg",
|
|
@@ -11,24 +11,15 @@
|
|
|
11
11
|
],
|
|
12
12
|
"type": "module",
|
|
13
13
|
"exports": {
|
|
14
|
-
".":
|
|
15
|
-
|
|
16
|
-
"default": "./src/index.js"
|
|
17
|
-
}
|
|
14
|
+
".": "./dist/index.js",
|
|
15
|
+
"./package.json": "./package.json"
|
|
18
16
|
},
|
|
19
17
|
"files": [
|
|
20
|
-
"
|
|
21
|
-
"src/**/*.d.ts"
|
|
18
|
+
"dist"
|
|
22
19
|
],
|
|
23
|
-
"scripts": {
|
|
24
|
-
"clean": "tsc -b --clean",
|
|
25
|
-
"tsc": "npm run clean && tsc -p ./tsconfig.json",
|
|
26
|
-
"tsc:pub": "npm run tsc",
|
|
27
|
-
"prepublishOnly": "npm run tsc"
|
|
28
|
-
},
|
|
29
20
|
"author": "killagu <killa123@126.com>",
|
|
30
21
|
"license": "MIT",
|
|
31
|
-
"homepage": "https://github.com/eggjs/tegg",
|
|
22
|
+
"homepage": "https://github.com/eggjs/tegg/tree/next/core/eventbus-decorator",
|
|
32
23
|
"bugs": {
|
|
33
24
|
"url": "https://github.com/eggjs/tegg/issues"
|
|
34
25
|
},
|
|
@@ -38,21 +29,29 @@
|
|
|
38
29
|
"directory": "core/eventbus-decorator"
|
|
39
30
|
},
|
|
40
31
|
"dependencies": {
|
|
41
|
-
"@eggjs/core-decorator": "
|
|
42
|
-
"@eggjs/tegg-common-util": "
|
|
43
|
-
"@eggjs/tegg-types": "
|
|
44
|
-
},
|
|
45
|
-
"engines": {
|
|
46
|
-
"node": ">=20.0.0"
|
|
32
|
+
"@eggjs/core-decorator": "4.0.0-beta.5",
|
|
33
|
+
"@eggjs/tegg-common-util": "4.0.0-beta.5",
|
|
34
|
+
"@eggjs/tegg-types": "4.0.0-beta.5"
|
|
47
35
|
},
|
|
48
36
|
"devDependencies": {
|
|
49
|
-
"@types/node": "22",
|
|
50
|
-
"coffee": "5",
|
|
51
|
-
"
|
|
52
|
-
"
|
|
37
|
+
"@types/node": "^22.10.5",
|
|
38
|
+
"coffee": "^5.1.0",
|
|
39
|
+
"typescript": "^5.9.3",
|
|
40
|
+
"tsdown": "^0.15.6",
|
|
41
|
+
"unplugin-unused": "^0.5.3"
|
|
42
|
+
},
|
|
43
|
+
"engines": {
|
|
44
|
+
"node": ">=22.18.0"
|
|
53
45
|
},
|
|
54
46
|
"publishConfig": {
|
|
55
47
|
"access": "public"
|
|
56
48
|
},
|
|
57
|
-
"
|
|
58
|
-
|
|
49
|
+
"main": "./dist/index.js",
|
|
50
|
+
"module": "./dist/index.js",
|
|
51
|
+
"types": "./dist/index.d.ts",
|
|
52
|
+
"scripts": {
|
|
53
|
+
"clean": "rimraf dist",
|
|
54
|
+
"build": "tsdown",
|
|
55
|
+
"typecheck": "tsc --noEmit"
|
|
56
|
+
}
|
|
57
|
+
}
|
package/src/Event.d.ts
DELETED
package/src/Event.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { AccessLevel, PrototypeUtil, SingletonProto } from '@eggjs/core-decorator';
|
|
2
|
-
import { StackUtil } from '@eggjs/tegg-common-util';
|
|
3
|
-
import { EventInfoUtil } from './EventInfoUtil.js';
|
|
4
|
-
export function Event(eventName) {
|
|
5
|
-
return function (clazz) {
|
|
6
|
-
EventInfoUtil.addEventName(eventName, clazz);
|
|
7
|
-
const func = SingletonProto({
|
|
8
|
-
accessLevel: AccessLevel.PUBLIC,
|
|
9
|
-
});
|
|
10
|
-
func(clazz);
|
|
11
|
-
PrototypeUtil.setFilePath(clazz, StackUtil.getCalleeFromStack(false, 5));
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJFdmVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsV0FBVyxFQUFFLGFBQWEsRUFBRSxjQUFjLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUNuRixPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFFcEQsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBS25ELE1BQU0sVUFBVSxLQUFLLENBQXlCLFNBQVk7SUFDeEQsT0FBTyxVQUFTLEtBQWdDO1FBQzlDLGFBQWEsQ0FBQyxZQUFZLENBQUMsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQzdDLE1BQU0sSUFBSSxHQUFHLGNBQWMsQ0FBQztZQUMxQixXQUFXLEVBQUUsV0FBVyxDQUFDLE1BQU07U0FDaEMsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ1osYUFBYSxDQUFDLFdBQVcsQ0FBQyxLQUFLLEVBQUUsU0FBUyxDQUFDLGtCQUFrQixDQUFDLEtBQUssRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzNFLENBQUMsQ0FBQztBQUNKLENBQUMifQ==
|
package/src/EventBus.d.ts
DELETED
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
import type { Events } from '@eggjs/tegg';
|
|
2
|
-
import type { IEventContext } from './EventContext.js';
|
|
3
|
-
import type { Arguments, TypedEventEmitter } from './typed-emitter.js';
|
|
4
|
-
export type EventName = string | symbol;
|
|
5
|
-
export type { Arguments };
|
|
6
|
-
/**
|
|
7
|
-
* use `emit` to emit a event
|
|
8
|
-
*/
|
|
9
|
-
export interface EventBus extends Pick<TypedEventEmitter<Events>, 'emit'> {
|
|
10
|
-
cork(corkId: string): void;
|
|
11
|
-
/**
|
|
12
|
-
* @return true if uncorked
|
|
13
|
-
*/
|
|
14
|
-
uncork(corkId: string): boolean;
|
|
15
|
-
}
|
|
16
|
-
export declare const CORK_ID: unique symbol;
|
|
17
|
-
export interface ContextEventBus extends EventBus {
|
|
18
|
-
cork(): void;
|
|
19
|
-
uncork(): boolean;
|
|
20
|
-
}
|
|
21
|
-
export type EventKeys = keyof Events;
|
|
22
|
-
/**
|
|
23
|
-
* use to ensure event will happen
|
|
24
|
-
* Can not inject for now, only use for unittest
|
|
25
|
-
*/
|
|
26
|
-
export interface EventWaiter {
|
|
27
|
-
await<E extends keyof Events>(event: E): Promise<Arguments<Events[E]>>;
|
|
28
|
-
awaitFirst<E1 extends EventKeys, E2 extends EventKeys>(e1: E1, e2: E2): Promise<{
|
|
29
|
-
event: E1 | E2;
|
|
30
|
-
args: Arguments<Events[E1] | Events[E2]>;
|
|
31
|
-
}>;
|
|
32
|
-
awaitFirst<E1 extends EventKeys, E2 extends EventKeys, E3 extends EventKeys>(e1: E1, e2: E2, e3: E3): Promise<{
|
|
33
|
-
event: E1 | E2 | E3;
|
|
34
|
-
args: Arguments<Events[E1] | Events[E2] | Events[E3]>;
|
|
35
|
-
}>;
|
|
36
|
-
awaitFirst<E1 extends EventKeys, E2 extends EventKeys, E3 extends EventKeys, E4 extends EventKeys>(e1: E1, e2: E2, e3: E3, e4: E4): Promise<{
|
|
37
|
-
event: E1 | E2 | E3 | E4;
|
|
38
|
-
args: Arguments<Events[E1] | Events[E2] | Events[E3] | Events[E4]>;
|
|
39
|
-
}>;
|
|
40
|
-
}
|
|
41
|
-
type EventHandlerWithContext<E extends keyof Events> = {
|
|
42
|
-
handle: (ctx: IEventContext, ...args: Arguments<Events[E]>) => ReturnType<Events[E]>;
|
|
43
|
-
};
|
|
44
|
-
export type EventHandler<E extends keyof Events> = {
|
|
45
|
-
handle: Events[E];
|
|
46
|
-
} | EventHandlerWithContext<E>;
|
package/src/EventBus.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
export const CORK_ID = Symbol.for('eventBus#corkId');
|
|
2
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRCdXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJFdmVudEJ1cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFxQkEsTUFBTSxDQUFDLE1BQU0sT0FBTyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsaUJBQWlCLENBQUMsQ0FBQyJ9
|
package/src/EventContext.d.ts
DELETED
package/src/EventContext.js
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import assert from 'node:assert';
|
|
2
|
-
import { EventInfoUtil } from './EventInfoUtil.js';
|
|
3
|
-
export function EventContext() {
|
|
4
|
-
return function (target, propertyKey, parameterIndex) {
|
|
5
|
-
assert(propertyKey === 'handle', `[eventHandler ${target.name}] expect method name be handle, but now is ${String(propertyKey)}`);
|
|
6
|
-
assert(parameterIndex === 0, `[eventHandler ${target.name}] expect param EventContext be the first param`);
|
|
7
|
-
const clazz = target.constructor;
|
|
8
|
-
EventInfoUtil.setEventHandlerContextInject(true, clazz);
|
|
9
|
-
};
|
|
10
|
-
}
|
|
11
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRDb250ZXh0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiRXZlbnRDb250ZXh0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUdBLE9BQU8sTUFBTSxNQUFNLGFBQWEsQ0FBQztBQUVqQyxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFNbkQsTUFBTSxVQUFVLFlBQVk7SUFDMUIsT0FBTyxVQUFTLE1BQVcsRUFBRSxXQUF3QixFQUFFLGNBQXNCO1FBQzNFLE1BQU0sQ0FBQyxXQUFXLEtBQUssUUFBUSxFQUM3QixpQkFBaUIsTUFBTSxDQUFDLElBQUksOENBQThDLE1BQU0sQ0FBQyxXQUFXLENBQUMsRUFBRSxDQUFDLENBQUM7UUFDbkcsTUFBTSxDQUFDLGNBQWMsS0FBSyxDQUFDLEVBQ3pCLGlCQUFpQixNQUFNLENBQUMsSUFBSSxnREFBZ0QsQ0FBQyxDQUFDO1FBQ2hGLE1BQU0sS0FBSyxHQUFHLE1BQU0sQ0FBQyxXQUFnQyxDQUFDO1FBQ3RELGFBQWEsQ0FBQyw0QkFBNEIsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDMUQsQ0FBQyxDQUFDO0FBQ0osQ0FBQyJ9
|
package/src/EventInfoUtil.d.ts
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import type { EggProtoImplClass } from '@eggjs/tegg-types';
|
|
2
|
-
import { EventName } from './EventBus.js';
|
|
3
|
-
export declare const EVENT_NAME: unique symbol;
|
|
4
|
-
export declare const EVENT_CONTEXT_INJECT: unique symbol;
|
|
5
|
-
export declare class EventInfoUtil {
|
|
6
|
-
/**
|
|
7
|
-
* @deprecated
|
|
8
|
-
*/
|
|
9
|
-
static setEventName(eventName: EventName, clazz: EggProtoImplClass): void;
|
|
10
|
-
static addEventName(eventName: EventName, clazz: EggProtoImplClass): void;
|
|
11
|
-
static getEventNameList(clazz: EggProtoImplClass): EventName[];
|
|
12
|
-
/**
|
|
13
|
-
* @deprecated
|
|
14
|
-
* return the last eventName which is subscribed firstly by Event decorator
|
|
15
|
-
*/
|
|
16
|
-
static getEventName(clazz: EggProtoImplClass): EventName | undefined;
|
|
17
|
-
static setEventHandlerContextInject(enable: boolean, clazz: EggProtoImplClass): void;
|
|
18
|
-
static getEventHandlerContextInject(clazz: EggProtoImplClass): boolean;
|
|
19
|
-
}
|
package/src/EventInfoUtil.js
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { MetadataUtil } from '@eggjs/core-decorator';
|
|
2
|
-
export const EVENT_NAME = Symbol.for('EggPrototype#eventName');
|
|
3
|
-
export const EVENT_CONTEXT_INJECT = Symbol.for('EggPrototype#event#handler#context#inject');
|
|
4
|
-
export class EventInfoUtil {
|
|
5
|
-
/**
|
|
6
|
-
* @deprecated
|
|
7
|
-
*/
|
|
8
|
-
static setEventName(eventName, clazz) {
|
|
9
|
-
EventInfoUtil.addEventName(eventName, clazz);
|
|
10
|
-
}
|
|
11
|
-
static addEventName(eventName, clazz) {
|
|
12
|
-
const eventNameList = MetadataUtil.initOwnArrayMetaData(EVENT_NAME, clazz, []);
|
|
13
|
-
eventNameList.push(eventName);
|
|
14
|
-
}
|
|
15
|
-
static getEventNameList(clazz) {
|
|
16
|
-
return MetadataUtil.getArrayMetaData(EVENT_NAME, clazz);
|
|
17
|
-
}
|
|
18
|
-
/**
|
|
19
|
-
* @deprecated
|
|
20
|
-
* return the last eventName which is subscribed firstly by Event decorator
|
|
21
|
-
*/
|
|
22
|
-
static getEventName(clazz) {
|
|
23
|
-
const eventNameList = MetadataUtil.initOwnArrayMetaData(EVENT_NAME, clazz, []);
|
|
24
|
-
if (eventNameList.length !== 0) {
|
|
25
|
-
return eventNameList[eventNameList.length - 1];
|
|
26
|
-
}
|
|
27
|
-
return undefined;
|
|
28
|
-
}
|
|
29
|
-
static setEventHandlerContextInject(enable, clazz) {
|
|
30
|
-
MetadataUtil.defineMetaData(EVENT_CONTEXT_INJECT, enable, clazz);
|
|
31
|
-
}
|
|
32
|
-
static getEventHandlerContextInject(clazz) {
|
|
33
|
-
return MetadataUtil.getMetaData(EVENT_CONTEXT_INJECT, clazz) ?? false;
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRXZlbnRJbmZvVXRpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIkV2ZW50SW5mb1V0aWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBSXJELE1BQU0sQ0FBQyxNQUFNLFVBQVUsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUM7QUFDL0QsTUFBTSxDQUFDLE1BQU0sb0JBQW9CLEdBQUcsTUFBTSxDQUFDLEdBQUcsQ0FBQywyQ0FBMkMsQ0FBQyxDQUFDO0FBRTVGLE1BQU0sT0FBTyxhQUFhO0lBQ3hCOztPQUVHO0lBQ0gsTUFBTSxDQUFDLFlBQVksQ0FBQyxTQUFvQixFQUFFLEtBQXdCO1FBQ2hFLGFBQWEsQ0FBQyxZQUFZLENBQUMsU0FBUyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQy9DLENBQUM7SUFFRCxNQUFNLENBQUMsWUFBWSxDQUFDLFNBQW9CLEVBQUUsS0FBd0I7UUFDaEUsTUFBTSxhQUFhLEdBQUcsWUFBWSxDQUFDLG9CQUFvQixDQUFZLFVBQVUsRUFBRSxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDMUYsYUFBYSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUNoQyxDQUFDO0lBRUQsTUFBTSxDQUFDLGdCQUFnQixDQUFDLEtBQXdCO1FBQzlDLE9BQU8sWUFBWSxDQUFDLGdCQUFnQixDQUFDLFVBQVUsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUMxRCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsTUFBTSxDQUFDLFlBQVksQ0FBQyxLQUF3QjtRQUMxQyxNQUFNLGFBQWEsR0FBRyxZQUFZLENBQUMsb0JBQW9CLENBQVksVUFBVSxFQUFFLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUMxRixJQUFJLGFBQWEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDL0IsT0FBTyxhQUFhLENBQUMsYUFBYSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNqRCxDQUFDO1FBQ0QsT0FBTyxTQUFTLENBQUM7SUFDbkIsQ0FBQztJQUVELE1BQU0sQ0FBQyw0QkFBNEIsQ0FBQyxNQUFlLEVBQUUsS0FBd0I7UUFDM0UsWUFBWSxDQUFDLGNBQWMsQ0FBQyxvQkFBb0IsRUFBRSxNQUFNLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDbkUsQ0FBQztJQUVELE1BQU0sQ0FBQyw0QkFBNEIsQ0FBQyxLQUF3QjtRQUMxRCxPQUFPLFlBQVksQ0FBQyxXQUFXLENBQUMsb0JBQW9CLEVBQUUsS0FBSyxDQUFDLElBQUksS0FBSyxDQUFDO0lBQ3hFLENBQUM7Q0FDRiJ9
|
package/src/index.d.ts
DELETED
package/src/index.js
DELETED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
export * from './EventBus.js';
|
|
2
|
-
export * from './Event.js';
|
|
3
|
-
export * from './EventInfoUtil.js';
|
|
4
|
-
export * from './EventContext.js';
|
|
5
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGVBQWUsQ0FBQztBQUM5QixjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLG9CQUFvQixDQUFDO0FBQ25DLGNBQWMsbUJBQW1CLENBQUMifQ==
|
package/src/type.d.ts
DELETED
package/src/typed-emitter.d.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
export type Arguments<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
|
|
2
|
-
/**
|
|
3
|
-
* Type-safe event emitter.
|
|
4
|
-
*
|
|
5
|
-
* Use it like this:
|
|
6
|
-
*
|
|
7
|
-
* interface MyEvents {
|
|
8
|
-
* error: (error: Error) => void
|
|
9
|
-
* message: (from: string, content: string) => void
|
|
10
|
-
* }
|
|
11
|
-
*
|
|
12
|
-
* const myEmitter = new EventEmitter() as TypedEmitter<MyEvents>
|
|
13
|
-
*
|
|
14
|
-
* myEmitter.on("message", (from, content) => {
|
|
15
|
-
* // ...
|
|
16
|
-
* })
|
|
17
|
-
*
|
|
18
|
-
* myEmitter.emit("error", "x") // <- Will catch this type error
|
|
19
|
-
*/
|
|
20
|
-
export interface TypedEventEmitter<Events> {
|
|
21
|
-
addListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
22
|
-
on<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
23
|
-
once<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
24
|
-
prependListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
25
|
-
prependOnceListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
26
|
-
off<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
27
|
-
removeAllListeners<E extends keyof Events>(event?: E): this;
|
|
28
|
-
removeListener<E extends keyof Events>(event: E, listener: Events[E]): this;
|
|
29
|
-
emit<E extends keyof Events>(event: E, ...args: Arguments<Events[E]>): boolean;
|
|
30
|
-
eventNames(): (keyof Events | string | symbol)[];
|
|
31
|
-
rawListeners<E extends keyof Events>(event: E): Function[];
|
|
32
|
-
listeners<E extends keyof Events>(event: E): Function[];
|
|
33
|
-
listenerCount<E extends keyof Events>(event: E): number;
|
|
34
|
-
getMaxListeners(): number;
|
|
35
|
-
setMaxListeners(maxListeners: number): this;
|
|
36
|
-
}
|
package/src/typed-emitter.js
DELETED
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
// forked from https://github.com/andywer/typed-emitter
|
|
2
|
-
// export TypedEventEmitter from 'typed-emitter'
|
|
3
|
-
export {};
|
|
4
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWQtZW1pdHRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInR5cGVkLWVtaXR0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsdURBQXVEO0FBQ3ZELGdEQUFnRCJ9
|