@wxn0brp/event-emitter 0.0.4 → 0.0.6
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 +16 -0
- package/dist/index.d.ts +5 -4
- package/dist/index.js +14 -8
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -54,6 +54,11 @@ emitter.emit('data', 42, new Date()); // Typescript suggests number and Date par
|
|
|
54
54
|
|
|
55
55
|
// You can still emit events without strict type checking
|
|
56
56
|
emitter.emit('unknown_event', 'any', 'data'); // This is still allowed at runtime
|
|
57
|
+
|
|
58
|
+
// Catch-all event listener for all events
|
|
59
|
+
emitter.on('*', (originalEvent, ...originalArgs) => {
|
|
60
|
+
console.log(`Received event "${originalEvent}":`, originalArgs);
|
|
61
|
+
});
|
|
57
62
|
```
|
|
58
63
|
|
|
59
64
|
## API
|
|
@@ -78,6 +83,17 @@ Removes an event listener.
|
|
|
78
83
|
|
|
79
84
|
Emits an event.
|
|
80
85
|
|
|
86
|
+
### Catch-all Event Listener
|
|
87
|
+
|
|
88
|
+
The special `*` event acts as a catch-all that receives all emitted events. When any event is emitted, it will also trigger listeners registered for the `*` event with the original event name as the first argument, followed by the original arguments.
|
|
89
|
+
|
|
90
|
+
Example:
|
|
91
|
+
```typescript
|
|
92
|
+
emitter.on("*", (originalEvent, ...originalArgs) => {
|
|
93
|
+
console.log(`Caught event "${originalEvent}" with args:`, originalArgs);
|
|
94
|
+
});
|
|
95
|
+
```
|
|
96
|
+
|
|
81
97
|
### `listenerCount(event: string): number`
|
|
82
98
|
|
|
83
99
|
Returns the number of listeners for the given event.
|
package/dist/index.d.ts
CHANGED
|
@@ -12,25 +12,26 @@ export declare class VEE<T extends EventMap = {}> {
|
|
|
12
12
|
* @param {K} event - event name
|
|
13
13
|
* @param {Function} listener - function to be called when event occurs
|
|
14
14
|
*/
|
|
15
|
-
on<K extends EventName<T>>(event: K, listener:
|
|
15
|
+
on<K extends EventName<T>>(event: K, listener: T[K]): () => this;
|
|
16
16
|
/**
|
|
17
17
|
* Registers a one-time event listener
|
|
18
18
|
* @param {K} event - event name
|
|
19
19
|
* @param {Function} listener - function to be called once
|
|
20
20
|
*/
|
|
21
|
-
once<K extends EventName<T>>(event: K, listener:
|
|
21
|
+
once<K extends EventName<T>>(event: K, listener: T[K]): () => this;
|
|
22
22
|
/**
|
|
23
23
|
* Removes an event listener.
|
|
24
24
|
* @param {K} event - event name
|
|
25
25
|
* @param {Function} listener - listener to remove
|
|
26
26
|
*/
|
|
27
|
-
off<K extends EventName<T>>(event: K, listener:
|
|
27
|
+
off<K extends EventName<T>>(event: K, listener: T[K]): this;
|
|
28
|
+
_emit(event: string, ...args: any[]): this;
|
|
28
29
|
/**
|
|
29
30
|
* Emits an event
|
|
30
31
|
* @param {K} event - event name
|
|
31
32
|
* @param {...EventArgs<T, K>} args - arguments to be passed to listeners
|
|
32
33
|
*/
|
|
33
|
-
emit<K extends EventName<T>>(event: K, ...args: EventArgs<T, K>):
|
|
34
|
+
emit<K extends EventName<T>>(event: K, ...args: EventArgs<T, K>): this;
|
|
34
35
|
/**
|
|
35
36
|
* Returns the number of listeners for the given event
|
|
36
37
|
* @param {K} event - event name
|
package/dist/index.js
CHANGED
|
@@ -10,6 +10,7 @@ export class VEE {
|
|
|
10
10
|
if (!this._events[_event])
|
|
11
11
|
this._events[_event] = [];
|
|
12
12
|
this._events[_event].push(listener);
|
|
13
|
+
return () => this.off(event, listener);
|
|
13
14
|
}
|
|
14
15
|
/**
|
|
15
16
|
* Registers a one-time event listener
|
|
@@ -21,7 +22,7 @@ export class VEE {
|
|
|
21
22
|
this.off(event, onceListener);
|
|
22
23
|
listener(...args);
|
|
23
24
|
};
|
|
24
|
-
this.on(event, onceListener);
|
|
25
|
+
return this.on(event, onceListener);
|
|
25
26
|
}
|
|
26
27
|
/**
|
|
27
28
|
* Removes an event listener.
|
|
@@ -31,8 +32,16 @@ export class VEE {
|
|
|
31
32
|
off(event, listener) {
|
|
32
33
|
const _event = event;
|
|
33
34
|
if (!this._events[_event])
|
|
34
|
-
return;
|
|
35
|
+
return this;
|
|
35
36
|
this._events[_event] = this._events[_event].filter(l => l !== listener);
|
|
37
|
+
return this;
|
|
38
|
+
}
|
|
39
|
+
_emit(event, ...args) {
|
|
40
|
+
const listeners = this._events[event];
|
|
41
|
+
if (!listeners?.length)
|
|
42
|
+
return this;
|
|
43
|
+
listeners.forEach(listener => listener(...args));
|
|
44
|
+
return this;
|
|
36
45
|
}
|
|
37
46
|
/**
|
|
38
47
|
* Emits an event
|
|
@@ -40,12 +49,9 @@ export class VEE {
|
|
|
40
49
|
* @param {...EventArgs<T, K>} args - arguments to be passed to listeners
|
|
41
50
|
*/
|
|
42
51
|
emit(event, ...args) {
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
listener(...args);
|
|
47
|
-
});
|
|
48
|
-
}
|
|
52
|
+
this._emit(event, ...args);
|
|
53
|
+
this._emit("*", event, ...args);
|
|
54
|
+
return this;
|
|
49
55
|
}
|
|
50
56
|
/**
|
|
51
57
|
* Returns the number of listeners for the given event
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wxn0brp/event-emitter",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"author": "wxn0brP",
|
|
@@ -13,7 +13,8 @@
|
|
|
13
13
|
},
|
|
14
14
|
"homepage": "https://github.com/wxn0brP/EventEmitter",
|
|
15
15
|
"devDependencies": {
|
|
16
|
-
"
|
|
16
|
+
"@wxn0brp/biome": "*",
|
|
17
|
+
"typescript": "^7"
|
|
17
18
|
},
|
|
18
19
|
"files": [
|
|
19
20
|
"dist"
|