kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-06-04 06:19:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

event-kit: update to use techniques from Atom.

Browse Source
This commit is contained in:
GlenCFL
2018-03-16 10:14:58 -04:00
parent 17c3e0a996
commit 335a8976a9
1 changed files with 38 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
types/event-kit/index.d.ts vendored
View File

@@ -1,4 +1,4 @@
// Type definitions for event-kit 2.x
// Type definitions for event-kit 2.4
// Project: https://github.com/atom/event-kit
// Definitions by: GlenCFL <https://github.com/GlenCFL>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -69,7 +69,8 @@ export class CompositeDisposable implements DisposableLike {
* for handlers registered via ::on to be invoked with calls to ::emit.
*/
// tslint:disable-next-line:no-any
export class Emitter<Emissions = { [key: string]: any }> implements DisposableLike {
export class Emitter<OptionalEmissions = { [key: string]: any }, RequiredEmissions = {}>
implements DisposableLike {
disposed: boolean;
/** Construct an emitter. */
@@ -83,31 +84,58 @@ export class Emitter<Emissions = { [key: string]: any }> implements DisposableLi
// Event Subscription
/** Registers a handler to be invoked whenever the given event is emitted. */
on<T extends keyof Emissions>(eventName: T, handler: (value?: Emissions[T]) => void):
Disposable;
on<T extends keyof OptionalEmissions>(eventName: T, handler: (value?:
OptionalEmissions[T]) => void): Disposable;
/** Registers a handler to be invoked whenever the given event is emitted. */
on<T extends keyof RequiredEmissions>(eventName: T, handler: (value:
RequiredEmissions[T]) => void): Disposable;
/**
* Register the given handler function to be invoked the next time an event
* with the given name is emitted via ::emit.
*/
once<T extends keyof Emissions>(eventName: T, handler: (value?: Emissions[T]) => void):
Disposable;
once<T extends keyof OptionalEmissions>(eventName: T, handler: (value?:
OptionalEmissions[T]) => void): Disposable;
/**
* Register the given handler function to be invoked the next time an event
* with the given name is emitted via ::emit.
*/
once<T extends keyof RequiredEmissions>(eventName: T, handler: (value:
RequiredEmissions[T]) => void): Disposable;
/**
* Register the given handler function to be invoked before all other
* handlers existing at the time of subscription whenever events by the
* given name are emitted via ::emit.
*/
preempt<T extends keyof Emissions>(eventName: T, handler: (value?: Emissions[T]) => void):
Disposable;
preempt<T extends keyof OptionalEmissions>(eventName: T, handler: (value?:
OptionalEmissions[T]) => void): Disposable;
/**
* Register the given handler function to be invoked before all other
* handlers existing at the time of subscription whenever events by the
* given name are emitted via ::emit.
*/
preempt<T extends keyof RequiredEmissions>(eventName: T, handler: (value:
RequiredEmissions[T]) => void): Disposable;
// Event Emission
/** Invoke the handlers registered via ::on for the given event name. */
emit<T extends keyof Emissions>(eventName: T, value?: Emissions[T]): void;
emit<T extends keyof OptionalEmissions>(eventName: T, value?:
OptionalEmissions[T]): void;
/** Invoke the handlers registered via ::on for the given event name. */
emit<T extends keyof RequiredEmissions>(eventName: T, value:
RequiredEmissions[T]): void;
/**
* Asynchronously invoke the handlers registered via ::on for the given event name.
* @return A promise that will be fulfilled once all handlers have been invoked.
*/
emitAsync<T extends keyof Emissions>(eventName: T, value?: Emissions[T]): Promise<void>;
emitAsync<T extends keyof OptionalEmissions>(eventName: T, value?:
OptionalEmissions[T]): Promise<void>;
/**
* Asynchronously invoke the handlers registered via ::on for the given event name.
* @return A promise that will be fulfilled once all handlers have been invoked.
*/
emitAsync<T extends keyof RequiredEmissions>(eventName: T, value:
RequiredEmissions[T]): Promise<void>;
}