Skip to content

Commit 3e3636a

Browse files
committed
doc: add typings for events
1 parent 8fdabcc commit 3e3636a

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

index.ts

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,3 +432,41 @@ export class PythonShell extends EventEmitter{
432432
return this.kill(signal)
433433
}
434434
};
435+
436+
// This interface is merged in with the above class definition
437+
export interface PythonShell {
438+
addListener(event: string, listener: (...args: any[]) => void): this;
439+
emit(event: string | symbol, ...args: any[]): boolean;
440+
on(event: string, listener: (...args: any[]) => void): this;
441+
once(event: string, listener: (...args: any[]) => void): this;
442+
prependListener(event: string, listener: (...args: any[]) => void): this;
443+
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
444+
445+
addListener(event: "message", listener: (parsedChunk: any) => void): this;
446+
emit(event: "message", parsedChunk: any): boolean;
447+
on(event: "message", listener: (parsedChunk: any) => void): this;
448+
once(event: "message", listener: (parsedChunk: any) => void): this;
449+
prependListener(event: "message", listener: (parsedChunk: any) => void): this;
450+
prependOnceListener(event: "message", listener: (parsedChunk: any) => void): this;
451+
452+
addListener(event: "stderr", listener: (parsedChunk: any) => void): this;
453+
emit(event: "stderr", parsedChunk: any): boolean;
454+
on(event: "stderr", listener: (parsedChunk: any) => void): this;
455+
once(event: "stderr", listener: (parsedChunk: any) => void): this;
456+
prependListener(event: "stderr", listener: (parsedChunk: any) => void): this;
457+
prependOnceListener(event: "stderr", listener: (parsedChunk: any) => void): this;
458+
459+
addListener(event: "close", listener: () => void): this;
460+
emit(event: "close", ): boolean;
461+
on(event: "close", listener: () => void): this;
462+
once(event: "close", listener: () => void): this;
463+
prependListener(event: "close", listener: () => void): this;
464+
prependOnceListener(event: "close", listener: () => void): this;
465+
466+
addListener(event: "error", listener: (error: PythonShellError) => void): this;
467+
emit(event: "error", error: PythonShellError): boolean;
468+
on(event: "error", listener: (error: PythonShellError) => void): this;
469+
once(event: "error", listener: (error: PythonShellError) => void): this;
470+
prependListener(event: "error", listener: (error: PythonShellError) => void): this;
471+
prependOnceListener(event: "error", listener: (error: PythonShellError) => void): this;
472+
}

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)