@stacksjs/events 0.56.34 → 0.57.2
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/dist/index.d.ts +32 -15
- package/dist/index.mjs +63 -5
- package/package.json +3 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,24 @@
|
|
|
1
|
-
|
|
2
|
-
export
|
|
3
|
-
|
|
1
|
+
export type EventType = string | symbol;
|
|
2
|
+
export type Handler<T = unknown> = (event: T) => void;
|
|
3
|
+
export type WildcardHandler<T = Record<string, unknown>> = (type: keyof T, event: T[keyof T]) => void;
|
|
4
|
+
export type EventHandlerList<T = unknown> = Array<Handler<T>>;
|
|
5
|
+
export type WildCardEventHandlerList<T = Record<string, unknown>> = Array<WildcardHandler<T>>;
|
|
6
|
+
export type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<keyof Events | '*', EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>>;
|
|
7
|
+
export interface Emitter<Events extends Record<EventType, unknown>> {
|
|
8
|
+
all: EventHandlerMap<Events>;
|
|
9
|
+
on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
|
|
10
|
+
on(type: '*', handler: WildcardHandler<Events>): void;
|
|
11
|
+
off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
|
|
12
|
+
off(type: '*', handler: WildcardHandler<Events>): void;
|
|
13
|
+
emit<Key extends keyof Events>(type: Key, event: Events[Key]): void;
|
|
14
|
+
emit<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): void;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Mitt: Tiny (~200b) functional event emitter / pubsub.
|
|
18
|
+
* @name mitt
|
|
19
|
+
* @returns {Mitt}
|
|
20
|
+
*/
|
|
21
|
+
export default function mitt<Events extends Record<EventType, unknown>>(all?: EventHandlerMap<Events>): Emitter<Events>;
|
|
4
22
|
/**
|
|
5
23
|
* This module provides a simple, yet powerful, event bus for the application.
|
|
6
24
|
*
|
|
@@ -24,22 +42,21 @@ export { default as mitt } from 'mitt';
|
|
|
24
42
|
*/
|
|
25
43
|
declare const events: typeof mitt;
|
|
26
44
|
declare const useEvent: {
|
|
27
|
-
<Key extends
|
|
28
|
-
<Key_1 extends
|
|
45
|
+
<Key extends EventType>(type: Key, event: Record<EventType, unknown>[Key]): void;
|
|
46
|
+
<Key_1 extends EventType>(type: undefined extends Record<EventType, unknown>[Key_1] ? Key_1 : never): void;
|
|
29
47
|
};
|
|
30
|
-
declare const useEvents:
|
|
48
|
+
declare const useEvents: Emitter<Record<EventType, unknown>>;
|
|
31
49
|
declare const dispatch: {
|
|
32
|
-
<Key extends
|
|
33
|
-
<Key_1 extends
|
|
50
|
+
<Key extends EventType>(type: Key, event: Record<EventType, unknown>[Key]): void;
|
|
51
|
+
<Key_1 extends EventType>(type: undefined extends Record<EventType, unknown>[Key_1] ? Key_1 : never): void;
|
|
34
52
|
};
|
|
35
53
|
declare const listen: {
|
|
36
|
-
<Key extends
|
|
37
|
-
(type:
|
|
54
|
+
<Key extends EventType>(type: Key, handler: Handler<Record<EventType, unknown>[Key]>): void;
|
|
55
|
+
(type: '*', handler: WildcardHandler<Record<EventType, unknown>>): void;
|
|
38
56
|
};
|
|
39
57
|
declare const off: {
|
|
40
|
-
<Key extends
|
|
41
|
-
(type:
|
|
58
|
+
<Key extends EventType>(type: Key, handler?: Handler<Record<EventType, unknown>[Key]> | undefined): void;
|
|
59
|
+
(type: '*', handler: WildcardHandler<Record<EventType, unknown>>): void;
|
|
42
60
|
};
|
|
43
|
-
declare const all:
|
|
44
|
-
|
|
45
|
-
export { all, dispatch, events, listen, off, useEvent, useEvents };
|
|
61
|
+
declare const all: EventHandlerMap<Record<EventType, unknown>>;
|
|
62
|
+
export { useEvent, useEvents, dispatch, listen, all, off, events, mitt };
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,65 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
export default function mitt(all2) {
|
|
2
|
+
all2 = all2 || /* @__PURE__ */ new Map();
|
|
3
|
+
return {
|
|
4
|
+
/**
|
|
5
|
+
* A Map of event names to registered handler functions.
|
|
6
|
+
*/
|
|
7
|
+
all: all2,
|
|
8
|
+
/**
|
|
9
|
+
* Register an event handler for the given type.
|
|
10
|
+
* @param {string|symbol} type Type of event to listen for, or `'*'` for all events
|
|
11
|
+
* @param {Function} handler Function to call in response to given event
|
|
12
|
+
* @memberOf mitt
|
|
13
|
+
*/
|
|
14
|
+
on(type, handler) {
|
|
15
|
+
const handlers = all2.get(type);
|
|
16
|
+
if (handlers)
|
|
17
|
+
handlers.push(handler);
|
|
18
|
+
else
|
|
19
|
+
all2.set(type, [handler]);
|
|
20
|
+
},
|
|
21
|
+
/**
|
|
22
|
+
* Remove an event handler for the given type.
|
|
23
|
+
* If `handler` is omitted, all handlers of the given type are removed.
|
|
24
|
+
* @param {string|symbol} type Type of event to unregister `handler` from (`'*'` to remove a wildcard handler)
|
|
25
|
+
* @param {Function} [handler] Handler function to remove
|
|
26
|
+
* @memberOf mitt
|
|
27
|
+
*/
|
|
28
|
+
off(type, handler) {
|
|
29
|
+
const handlers = all2.get(type);
|
|
30
|
+
if (handlers) {
|
|
31
|
+
if (handler)
|
|
32
|
+
handlers.splice(handlers.indexOf(handler) >>> 0, 1);
|
|
33
|
+
else
|
|
34
|
+
all2.set(type, []);
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
/**
|
|
38
|
+
* Invoke all handlers for the given type.
|
|
39
|
+
* If present, `'*'` handlers are invoked after type-matched handlers.
|
|
40
|
+
*
|
|
41
|
+
* Note: Manually firing '*' handlers is not supported.
|
|
42
|
+
*
|
|
43
|
+
* @param {string|symbol} type The event type to invoke
|
|
44
|
+
* @param {Any} [evt] Any value (object is recommended and powerful), passed to each handler
|
|
45
|
+
* @memberOf mitt
|
|
46
|
+
*/
|
|
47
|
+
emit(type, evt) {
|
|
48
|
+
let handlers = all2.get(type);
|
|
49
|
+
if (handlers) {
|
|
50
|
+
handlers.slice().map((handler) => {
|
|
51
|
+
return handler(evt);
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
handlers = all2.get("*");
|
|
55
|
+
if (handlers) {
|
|
56
|
+
handlers.slice().map((handler) => {
|
|
57
|
+
return handler(type, evt);
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
}
|
|
4
63
|
const events = mitt;
|
|
5
64
|
const emitter = events();
|
|
6
65
|
const useEvent = emitter.emit;
|
|
@@ -9,5 +68,4 @@ const dispatch = emitter.emit;
|
|
|
9
68
|
const listen = emitter.on;
|
|
10
69
|
const off = emitter.off;
|
|
11
70
|
const all = emitter.all;
|
|
12
|
-
|
|
13
|
-
export { all, dispatch, events, listen, off, useEvent, useEvents };
|
|
71
|
+
export { useEvent, useEvents, dispatch, listen, all, off, events, mitt };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacksjs/events",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.57.2",
|
|
5
5
|
"packageManager": "pnpm@8.6.5",
|
|
6
6
|
"description": "Functional event emitting.",
|
|
7
7
|
"author": "Chris Breuer",
|
|
@@ -39,11 +39,10 @@
|
|
|
39
39
|
"README.md"
|
|
40
40
|
],
|
|
41
41
|
"peerDependencies": {
|
|
42
|
-
"
|
|
43
|
-
"@stacksjs/alias": "0.56.34"
|
|
42
|
+
"@stacksjs/alias": "0.57.2"
|
|
44
43
|
},
|
|
45
44
|
"devDependencies": {
|
|
46
|
-
"@stacksjs/development": "0.
|
|
45
|
+
"@stacksjs/development": "0.57.2"
|
|
47
46
|
},
|
|
48
47
|
"scripts": {
|
|
49
48
|
"build": "unbuild",
|