Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.9.10 legacy TS handling, use "in" for object literals having TS < 4.4 #293

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -807,3 +807,25 @@ emitter.emit('event', 'never handled');
### EventEmitter2.defaultMaxListeners

Sets default max listeners count globally for all instances, including those created before the change is made.

### Strongly typed events
For using strongly type events (_available only in `TypeScript`_) you can create a new `EventEmitter` instance like this:

```ts
import EventEmitter2 from "eventemitter2";

type events = {
error: (err: Error) => void
message: (sender: string, msg: string) => void
}

const emitter = new EventEmitter2<events>()

// Ok
emitter.emit("error", new Error("example"))
emitter.emit("message", "someone", "hello")

// TypeScript catches mistakes
emitter.emit("error", true)
emitter.emit("message", 1, "hello")
```
43 changes: 39 additions & 4 deletions eventemitter2.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
export type event = (symbol|string);
export type eventNS = string|event[];
export type typeSafeEvents = {
[key in event]: (...args: any[]) => void
}

export interface ConstructorOptions {
/**
Expand Down Expand Up @@ -118,32 +121,64 @@ export interface Listener {
off(): this;
}

export declare class EventEmitter2 {
export declare class EventEmitter2<TypeSafeEvents extends typeSafeEvents = { [key in event]: (...args: any[]) => void }> {
constructor(options?: ConstructorOptions)
emit(event: event | eventNS, ...values: any[]): boolean;
emitAsync(event: event | eventNS, ...values: any[]): Promise<any[]>;
emit<Event extends keyof TypeSafeEvents>(event: Event | Event[], ...values: Parameters<TypeSafeEvents[Event]>): boolean;
emitAsync<Event extends keyof TypeSafeEvents>(event: Event | Event[], ...values: Parameters<TypeSafeEvents[Event]>): Promise<any[]>;

addListener<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event]): this|Listener;
addListener(event: event | eventNS, listener: ListenerFn): this|Listener;

on<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event]): this|Listener;
on(event: event | eventNS, listener: ListenerFn, options?: boolean|OnOptions): this|Listener;

prependListener<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event], options?: boolean|OnOptions): this|Listener;
prependListener(event: event | eventNS, listener: ListenerFn, options?: boolean|OnOptions): this|Listener;

once<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event], options?: true|OnOptions): this|Listener;
once(event: event | eventNS, listener: ListenerFn, options?: true|OnOptions): this|Listener;

prependOnceListener<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event], options?: boolean|OnOptions): this|Listener;
prependOnceListener(event: event | eventNS, listener: ListenerFn, options?: boolean|OnOptions): this|Listener;

many<Event extends keyof TypeSafeEvents>(event: Event | Event, timesToListen: number, listener: TypeSafeEvents[Event], options?: boolean|OnOptions): this|Listener;
many(event: event | eventNS, timesToListen: number, listener: ListenerFn, options?: boolean|OnOptions): this|Listener;

prependMany<Event extends keyof TypeSafeEvents>(event: Event | Event, timesToListen: number, listener: TypeSafeEvents[Event], options?: boolean|OnOptions): this|Listener;
prependMany(event: event | eventNS, timesToListen: number, listener: ListenerFn, options?: boolean|OnOptions): this|Listener;

onAny(listener: EventAndListener): this;
prependAny(listener: EventAndListener): this;
offAny(listener: ListenerFn): this;

removeListener<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event]): this;
removeListener(event: event | eventNS, listener: ListenerFn): this;

off<Event extends keyof TypeSafeEvents>(event: Event | Event, listener: TypeSafeEvents[Event]): this;
off(event: event | eventNS, listener: ListenerFn): this;
removeAllListeners(event?: event | eventNS): this;

removeAllListeners<Event extends keyof TypeSafeEvents>(event?: Event | Event[] | eventNS): this;
setMaxListeners(n: number): void;
getMaxListeners(): number;
eventNames(nsAsArray?: boolean): (event|eventNS)[];

listenerCount<Event extends keyof TypeSafeEvents>(event?: Event | Event[]): number
listenerCount(event?: event | eventNS): number

listeners<Event extends keyof TypeSafeEvents>(event?: Event): Array<TypeSafeEvents[Event]>
listeners(event?: event | eventNS): ListenerFn[]

listenersAny(): ListenerFn[]

waitFor<Event extends keyof TypeSafeEvents>(event: Event, timeout?: number): CancelablePromise<any[]>
waitFor(event: event | eventNS, timeout?: number): CancelablePromise<any[]>

waitFor<Event extends keyof TypeSafeEvents>(event: Event, filter?: WaitForFilter): CancelablePromise<any[]>
waitFor(event: event | eventNS, filter?: WaitForFilter): CancelablePromise<any[]>

waitFor<Event extends keyof TypeSafeEvents>(event: Event, options?: WaitForOptions): CancelablePromise<any[]>
waitFor(event: event | eventNS, options?: WaitForOptions): CancelablePromise<any[]>

listenTo(target: GeneralEventEmitter, events: event | eventNS, options?: ListenToOptions): this;
listenTo(target: GeneralEventEmitter, events: event[], options?: ListenToOptions): this;
listenTo(target: GeneralEventEmitter, events: Object, options?: ListenToOptions): this;
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eventemitter2",
"version": "6.4.9",
"version": "6.4.10",
"description": "A feature-rich Node.js event emitter implementation with namespaces, wildcards, TTL, async listeners and browser/worker support.",
"keywords": [
"event",
Expand Down