mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-18 12:08:59 +08:00
a1c646f26a
* Make fbemitter a namespace * Tighten up typing of flux * Update flux tests * Address code comments * Fix RealOptions interface
72 lines
2.2 KiB
TypeScript
72 lines
2.2 KiB
TypeScript
// Type definitions for Facebook's EventEmitter 2.0.0
|
|
// Project: https://github.com/facebook/emitter
|
|
// Definitions by: kmxz <https://github.com/kmxz>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare namespace FBEmitter {
|
|
|
|
export class EventSubscription {
|
|
|
|
listener: Function;
|
|
context: any;
|
|
|
|
/**
|
|
* Removes this subscription from the subscriber that controls it.
|
|
*/
|
|
remove(): void;
|
|
|
|
}
|
|
|
|
export class EventEmitter {
|
|
|
|
constructor();
|
|
|
|
/**
|
|
* Adds a listener to be invoked when events of the specified type are
|
|
* emitted. An optional calling context may be provided. The data arguments
|
|
* emitted will be passed to the listener function.
|
|
*/
|
|
addListener(eventType: string, listener: Function, context?: any): EventSubscription;
|
|
|
|
/**
|
|
* Similar to addListener, except that the listener is removed after it is
|
|
* invoked once.
|
|
*/
|
|
once(eventType: string, listener: Function, context?: any): EventSubscription;
|
|
|
|
/**
|
|
* Removes all of the registered listeners, including those registered as
|
|
* listener maps.
|
|
*/
|
|
removeAllListeners(eventType?: string): void;
|
|
|
|
/**
|
|
* Provides an API that can be called during an eventing cycle to remove the
|
|
* last listener that was invoked. This allows a developer to provide an event
|
|
* object that can remove the listener (or listener map) during the
|
|
* invocation.
|
|
*
|
|
* If it is called when not inside of an emitting cycle it will throw.
|
|
*/
|
|
removeCurrentListener(): void;
|
|
|
|
/**
|
|
* Returns an array of listeners that are currently registered for the given
|
|
* event.
|
|
*/
|
|
listeners(eventType: string): Function[];
|
|
|
|
/**
|
|
* Emits an event of the given type with the given data. All handlers of that
|
|
* particular type will be notified.
|
|
*/
|
|
emit(eventType: string, ...data: any[]): void;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
declare module 'fbemitter' {
|
|
export = FBEmitter;
|
|
}
|