forked from EventEmitter2/EventEmitter2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patheventemitter2.d.ts
57 lines (56 loc) · 2.18 KB
/
eventemitter2.d.ts
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
54
55
56
57
export type eventNS = string[];
export interface ConstructorOptions {
/**
* @default false
* @description set this to `true` to use wildcards.
*/
wildcard?: boolean,
/**
* @default '.'
* @description the delimiter used to segment namespaces.
*/
delimiter?: string,
/**
* @default true
* @description set this to `true` if you want to emit the newListener events.
*/
newListener?: boolean,
/**
* @default 10
* @description the maximum amount of listeners that can be assigned to an event.
*/
maxListeners?: number
/**
* @default false
* @description show event name in memory leak message when more than maximum amount of listeners is assigned, default false
*/
verboseMemoryLeak?: boolean;
}
export interface Listener {
(...values: any[]): void;
}
export interface EventAndListener {
(event: string | string[], ...values: any[]): void;
}
export declare class EventEmitter2 {
constructor(options?: ConstructorOptions)
emit(event: string | string[], ...values: any[]): boolean;
emitAsync(event: string | string[], ...values: any[]): Promise<any[]>;
addListener(event: string, listener: Listener): this;
on(event: string | string[], listener: Listener): this;
prependListener(event: string | string[], listener: Listener): this;
once(event: string | string[], listener: Listener): this;
prependOnceListener(event: string | string[], listener: Listener): this;
many(event: string | string[], timesToListen: number, listener: Listener): this;
prependMany(event: string | string[], timesToListen: number, listener: Listener): this;
onAny(listener: EventAndListener): this;
prependAny(listener: EventAndListener): this;
offAny(listener: Listener): this;
removeListener(event: string | string[], listener: Listener): this;
off(event: string, listener: Listener): this;
removeAllListeners(event?: string | eventNS): this;
setMaxListeners(n: number): void;
eventNames(): string[];
listeners(event: string | string[]): Listener[] // TODO: not in documentation by Willian
listenersAny(): Listener[] // TODO: not in documentation by Willian
}