75 lines
3.3 KiB
TypeScript
75 lines
3.3 KiB
TypeScript
|
// Type definitions for es6-promise
|
||
|
|
// Project: https://github.com/jakearchibald/ES6-Promise
|
||
|
|
// Definitions by: François de Campredon <https://github.com/fdecampredon/>, vvakame <https://github.com/vvakame>
|
||
|
|
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||
|
|
|
||
|
|
interface Thenable<R> {
|
||
|
|
then<U>(onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
|
||
|
|
then<U>(onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => void): Thenable<U>;
|
||
|
|
catch<U>(onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
|
||
|
|
}
|
||
|
|
|
||
|
|
declare class Promise<R> implements Thenable<R> {
|
||
|
|
/**
|
||
|
|
* If you call resolve in the body of the callback passed to the constructor,
|
||
|
|
* your promise is fulfilled with result object passed to resolve.
|
||
|
|
* If you call reject your promise is rejected with the object passed to reject.
|
||
|
|
* For consistency and debugging (eg stack traces), obj should be an instanceof Error.
|
||
|
|
* Any errors thrown in the constructor callback will be implicitly passed to reject().
|
||
|
|
*/
|
||
|
|
constructor(callback: (resolve : (value?: R | Thenable<R>) => void, reject: (error?: any) => void) => void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* onFulfilled is called when/if "promise" resolves. onRejected is called when/if "promise" rejects.
|
||
|
|
* Both are optional, if either/both are omitted the next onFulfilled/onRejected in the chain is called.
|
||
|
|
* Both callbacks have a single parameter , the fulfillment value or rejection reason.
|
||
|
|
* "then" returns a new promise equivalent to the value you return from onFulfilled/onRejected after being passed through Promise.resolve.
|
||
|
|
* If an error is thrown in the callback, the returned promise rejects with that error.
|
||
|
|
*
|
||
|
|
* @param onFulfilled called when/if "promise" resolves
|
||
|
|
* @param onRejected called when/if "promise" rejects
|
||
|
|
*/
|
||
|
|
then<U>(onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Promise<U>;
|
||
|
|
then<U>(onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => void): Promise<U>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sugar for promise.then(undefined, onRejected)
|
||
|
|
*
|
||
|
|
* @param onRejected called when/if "promise" rejects
|
||
|
|
*/
|
||
|
|
catch<U>(onRejected?: (error: any) => U | Thenable<U>): Promise<U>;
|
||
|
|
}
|
||
|
|
|
||
|
|
declare module Promise {
|
||
|
|
/**
|
||
|
|
* Make a new promise from the thenable.
|
||
|
|
* A thenable is promise-like in as far as it has a "then" method.
|
||
|
|
*/
|
||
|
|
function resolve<R>(value?: R | Thenable<R>): Promise<R>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Make a promise that rejects to obj. For consistency and debugging (eg stack traces), obj should be an instanceof Error
|
||
|
|
*/
|
||
|
|
function reject(error: any): Promise<any>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Make a promise that fulfills when every item in the array fulfills, and rejects if (and when) any item rejects.
|
||
|
|
* the array passed to all can be a mixture of promise-like objects and other objects.
|
||
|
|
* The fulfillment value is an array (in order) of fulfillment values. The rejection value is the first rejection value.
|
||
|
|
*/
|
||
|
|
function all<R>(promises: (R | Thenable<R>)[]): Promise<R[]>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Make a Promise that fulfills when any item fulfills, and rejects if any item rejects.
|
||
|
|
*/
|
||
|
|
function race<R>(promises: (R | Thenable<R>)[]): Promise<R>;
|
||
|
|
}
|
||
|
|
|
||
|
|
declare module 'es6-promise' {
|
||
|
|
var foo: typeof Promise; // Temp variable to reference Promise in local context
|
||
|
|
module rsvp {
|
||
|
|
export var Promise: typeof foo;
|
||
|
|
}
|
||
|
|
export = rsvp;
|
||
|
|
}
|