// Type definitions for promise 7.0.4
// Project: https://www.npmjs.com/package/promise
// Code base: https://github.com/borisyankov/DefinitelyTyped/blob/35119c83fe214d18c7e370a678cd85dfcfbfa42a/es6-promise/es6-promise.d.ts
// Definitions by: François de Campredon , vvakame
// Adapted by: Zorbing
/* =================== USAGE ===================
import * as Promise from "promise";
=============================================== */
declare module Promise
{
interface Thenable
{
then(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => U | Thenable): Thenable;
then(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => void): Thenable;
}
interface Instance
{
/**
* 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(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => U | Thenable): Instance;
then(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => void): Instance;
/**
* Sugar for promise.then(undefined, onRejected)
*
* @param onRejected called when/if "promise" rejects
*/
catch(onRejected?: (error: any) => U | Thenable): Instance;
done(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => U | Thenable): void;
done(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => void): void;
finally(onFulfilled?: (value?: R | Thenable) => Instance): Instance;
nodeify(callback: (error: any, value?: R) => void, context: any): Instance | void;
}
interface Static
{
/**
* 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 resolve.
* 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().
*/
new (callback: (resolve : (value?: R | Thenable) => void, reject: (error?: any) => void) => void): Instance
/**
* Make a new promise from the thenable.
* A thenable is promise-like in as far as it has a "then" method.
*/
resolve(value?: T | Thenable): Instance;
/**
* Make a promise that rejects to obj. For consistency and debugging (eg stack traces), obj should be an instanceof Error
*/
reject(error: any): Instance;
/**
* 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.
*/
all(promises: (T | Thenable)[]): Instance;
/**
* Make a Promise that fulfills when any item fulfills, and rejects if any item rejects.
*/
race(promises: (T | Thenable)[]): Instance;
denodeify(fn: Function, argumentCount?: number): (...args: any[]) => Instance;
nodeify(fn: Function): (...args: any[]) => Instance | any;
}
}
declare module "promise"
{
export = promise;
}
declare var promise: Promise.Static;