es6-promise.d.ts 5.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. export interface Thenable <R> {
  2. then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
  3. then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => void): Thenable<U>;
  4. }
  5. export class Promise <R> implements Thenable <R> {
  6. /**
  7. * If you call resolve in the body of the callback passed to the constructor,
  8. * your promise is fulfilled with result object passed to resolve.
  9. * If you call reject your promise is rejected with the object passed to resolve.
  10. * For consistency and debugging (eg stack traces), obj should be an instanceof Error.
  11. * Any errors thrown in the constructor callback will be implicitly passed to reject().
  12. */
  13. constructor (callback: (resolve : (value?: R | Thenable<R>) => void, reject: (error?: any) => void) => void);
  14. /**
  15. * onFulfilled is called when/if "promise" resolves. onRejected is called when/if "promise" rejects.
  16. * Both are optional, if either/both are omitted the next onFulfilled/onRejected in the chain is called.
  17. * Both callbacks have a single parameter , the fulfillment value or rejection reason.
  18. * "then" returns a new promise equivalent to the value you return from onFulfilled/onRejected after being passed through Promise.resolve.
  19. * If an error is thrown in the callback, the returned promise rejects with that error.
  20. *
  21. * @param onFulfilled called when/if "promise" resolves
  22. * @param onRejected called when/if "promise" rejects
  23. */
  24. then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Promise<U>;
  25. then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => void): Promise<U>;
  26. /**
  27. * Sugar for promise.then(undefined, onRejected)
  28. *
  29. * @param onRejected called when/if "promise" rejects
  30. */
  31. catch <U> (onRejected?: (error: any) => U | Thenable<U>): Promise<U>;
  32. /**
  33. * onSettled is invoked when/if the "promise" settles (either rejects or fulfills);
  34. *
  35. * @param onFinally called when/if "promise" settles
  36. */
  37. finally <U> (onFinally?: (callback: any) => U | Thenable<U>): Promise<U>;
  38. /**
  39. * Make a new promise from the thenable.
  40. * A thenable is promise-like in as far as it has a "then" method.
  41. */
  42. static resolve (): Promise<void>;
  43. static resolve <R> (value: R | Thenable<R>): Promise<R>;
  44. /**
  45. * Make a promise that rejects to obj. For consistency and debugging (eg stack traces), obj should be an instanceof Error
  46. */
  47. static reject <R> (error: any): Promise<R>;
  48. /**
  49. * Make a promise that fulfills when every item in the array fulfills, and rejects if (and when) any item rejects.
  50. * the array passed to all can be a mixture of promise-like objects and other objects.
  51. * The fulfillment value is an array (in order) of fulfillment values. The rejection value is the first rejection value.
  52. */
  53. static all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>, T5 | Thenable<T5>, T6 | Thenable<T6>, T7 | Thenable<T7>, T8 | Thenable<T8>, T9 | Thenable<T9>, T10 | Thenable<T10>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>;
  54. static all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>, T5 | Thenable<T5>, T6 | Thenable<T6>, T7 | Thenable<T7>, T8 | Thenable<T8>, T9 | Thenable<T9>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>;
  55. static all<T1, T2, T3, T4, T5, T6, T7, T8>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>, T5 | Thenable<T5>, T6 | Thenable<T6>, T7 | Thenable<T7>, T8 | Thenable<T8>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>;
  56. static all<T1, T2, T3, T4, T5, T6, T7>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>, T5 | Thenable<T5>, T6 | Thenable<T6>, T7 | Thenable<T7>]): Promise<[T1, T2, T3, T4, T5, T6, T7]>;
  57. static all<T1, T2, T3, T4, T5, T6>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>, T5 | Thenable<T5>, T6 | Thenable<T6>]): Promise<[T1, T2, T3, T4, T5, T6]>;
  58. static all<T1, T2, T3, T4, T5>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>, T5 | Thenable<T5>]): Promise<[T1, T2, T3, T4, T5]>;
  59. static all<T1, T2, T3, T4>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>, T4 | Thenable <T4>]): Promise<[T1, T2, T3, T4]>;
  60. static all<T1, T2, T3>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>, T3 | Thenable<T3>]): Promise<[T1, T2, T3]>;
  61. static all<T1, T2>(values: [T1 | Thenable<T1>, T2 | Thenable<T2>]): Promise<[T1, T2]>;
  62. static all<T1>(values: [T1 | Thenable<T1>]): Promise<[T1]>;
  63. static all<TAll>(values: Array<TAll | Thenable<TAll>>): Promise<TAll[]>;
  64. /**
  65. * Make a Promise that fulfills when any item fulfills, and rejects if any item rejects.
  66. */
  67. static race <R> (promises: (R | Thenable<R>)[]): Promise<R>;
  68. }
  69. /**
  70. * The polyfill method will patch the global environment (in this case to the Promise name) when called.
  71. */
  72. export function polyfill (): void;