aboutsummaryrefslogtreecommitdiff
path: root/mitt.d.ts
blob: 6cb62d8f4af20d380dbb639a954f58d3d893deb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
declare var mitt: mitt.MittStatic;

declare module "mitt" {
    export = mitt;
}

declare namespace mitt {
	type Handler = (event?: any) => void;
	type WildcardHandler = (type: string, event?: any) => void;

	interface MittStatic {
		(all?: {[key: string]: Array<Handler>}): Emitter;
	}

	interface Emitter {
		/**
		 * Register an event handler for the given type.
		 *
		 * @param {string} type Type of event to listen for, or `"*"` for all events.
		 * @param {Handler} handler Function to call in response to the given event.
		 *
		 * @memberOf Mitt
		 */
		on(type: string, handler: Handler): void;
		on(type: "*", handler: WildcardHandler): void;

		/**
		 * Function to call in response to the given event
		 *
		 * @param {string} type Type of event to unregister `handler` from, or `"*"`
		 * @param {Handler} handler Handler function to remove.
		 *
		 * @memberOf Mitt
		 */
		off(type: string, handler: Handler): void;
		off(type: "*", handler: WildcardHandler): void;

		/**
		 * Invoke all handlers for the given type.
		 * If present, `"*"` handlers are invoked prior to type-matched handlers.
		 *
		 * @param {string} type The event type to invoke
		 * @param {any} [event] An event object, passed to each handler
		 *
		 * @memberOf Mitt
		 */
		emit(type: string, event?: any): void;
		/**
		 * Note: Manually firing "*" events is unsupported.
		 */
		emit(type: "*", event?: any): void;
	}
}