mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-30 18:43:21 +08:00
9b53298395
* Support Partial<> on setState now that TS 2.1 is out * Update readme to reflect setState being typed correctly * Switch setState to Pick * Restore cloneELement portion of readme * Use Pick<> | S for setState due to cast issue * state and props should be readonly * Fix nit + document why we * Add typescript compiler header * Update to properly order headers * Update readme to reflect 2.1.5 fixing stPick * Update readme now that 2.1.5 is out * All that depend on react now require 2.1 * Fix definition that fails due to readonly state
70 lines
2.3 KiB
TypeScript
70 lines
2.3 KiB
TypeScript
// Type definitions for Flux 3.0
|
|
// Project: http://facebook.github.io/flux/
|
|
// Definitions by: Steve Baker <https://github.com/stkb/>, Giedrius Grabauskas <https://github.com/GiedriusGrabauskas/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.1
|
|
|
|
/// <reference types="react" />
|
|
/// <reference types="fbemitter" />
|
|
|
|
export = Flux;
|
|
|
|
declare namespace Flux {
|
|
|
|
/**
|
|
* Dispatcher class
|
|
* Create an instance to use throughout the application.
|
|
* Or extend it to create a derived dispatcher class.
|
|
*
|
|
* Specify a type in the 'TPayload' generic argument to use strongly-typed payloads,
|
|
* otherwise specify 'any'
|
|
*
|
|
* Examples:
|
|
* var dispatcher = new flux.Dispatcher<any>()
|
|
* var typedDispatcher = new flux.Dispatcher<MyCustomActionType>()
|
|
* class DerivedDispatcher extends flux.Dispatcher<MyCustomActionType> { }
|
|
*/
|
|
export class Dispatcher<TPayload> {
|
|
|
|
/**
|
|
* Create an instance of the Dispatcher class to use throughout the application.
|
|
*
|
|
* Specify a type in the 'TPayload' generic argument to use strongly-typed payloads,
|
|
* otherwise specify 'any'
|
|
*
|
|
* Examples:
|
|
* var dispatcher = new flux.Dispatcher<any>()
|
|
* var typedDispatcher = new flux.Dispatcher<MyCustomActionType>()
|
|
*/
|
|
constructor();
|
|
|
|
/**
|
|
* Registers a callback that will be invoked with every payload sent to the dispatcher.
|
|
* Returns a string token to identify the callback to be used with waitFor() or unregister.
|
|
*/
|
|
register(callback: (payload: TPayload) => void): string;
|
|
|
|
/**
|
|
* Unregisters a callback with the given ID token
|
|
*/
|
|
unregister(id: string): void;
|
|
|
|
/**
|
|
* Waits for the callbacks with the specified IDs to be invoked before continuing execution
|
|
* of the current callback. This method should only be used by a callback in response
|
|
* to a dispatched payload.
|
|
*/
|
|
waitFor(IDs: string[]): void;
|
|
|
|
/**
|
|
* Dispatches a payload to all registered callbacks
|
|
*/
|
|
dispatch(payload: TPayload): void;
|
|
|
|
/**
|
|
* Gets whether the dispatcher is currently dispatching
|
|
*/
|
|
isDispatching(): boolean;
|
|
}
|
|
}
|