lie.d.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. // Type definitions for lie 3.2
  2. // Project: https://github.com/calvinmetcalf/lie#readme
  3. // Definitions by: Andre Wiggins <https://github.com/andrewiggins>
  4. // TypeScript Version: 2.3
  5. // These types are copied from TypeScript's built-in Promise types
  6. // and extended with extra Lie utilities namely, finally.
  7. export as namespace Promise;
  8. /**
  9. * Represents the completion of an asynchronous operation
  10. */
  11. interface Promise<T> {
  12. /**
  13. * Attaches callbacks for the resolution and/or rejection of the Promise.
  14. * @param onfulfilled The callback to execute when the Promise is resolved.
  15. * @param onrejected The callback to execute when the Promise is rejected.
  16. * @returns A Promise for the completion of which ever callback is executed.
  17. */
  18. then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
  19. /**
  20. * Attaches a callback for only the rejection of the Promise.
  21. * @param onrejected The callback to execute when the Promise is rejected.
  22. * @returns A Promise for the completion of the callback.
  23. */
  24. catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
  25. /**
  26. * When the promise is settled, whether fulfilled or rejected, execute the
  27. * specified callback function. This provides a way for code that must be
  28. * executed once the Promise has been dealt with to be run whether the promise
  29. * was fulfilled successfully or rejected.
  30. * @param onfinally Function called when the Promise is settled
  31. * @returns A Promise whose finally handler is set to the specified function, onfinally.
  32. */
  33. finally<TResult = never>(onfinally?: (() => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
  34. }
  35. interface PromiseConstructor {
  36. /**
  37. * A reference to the prototype.
  38. */
  39. readonly prototype: Promise<any>;
  40. /**
  41. * Creates a new Promise.
  42. * @param executor A callback used to initialize the promise. This callback is passed two arguments:
  43. * a resolve callback used resolve the promise with a value or the result of another promise,
  44. * and a reject callback used to reject the promise with a provided reason or error.
  45. */
  46. new <T>(executor: (resolve: (value?: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;
  47. /**
  48. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  49. * resolve, or rejected when any Promise is rejected.
  50. * @param values An array of Promises.
  51. * @returns A new Promise.
  52. */
  53. all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>;
  54. /**
  55. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  56. * resolve, or rejected when any Promise is rejected.
  57. * @param values An array of Promises.
  58. * @returns A new Promise.
  59. */
  60. all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>;
  61. /**
  62. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  63. * resolve, or rejected when any Promise is rejected.
  64. * @param values An array of Promises.
  65. * @returns A new Promise.
  66. */
  67. all<T1, T2, T3, T4, T5, T6, T7, T8>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>;
  68. /**
  69. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  70. * resolve, or rejected when any Promise is rejected.
  71. * @param values An array of Promises.
  72. * @returns A new Promise.
  73. */
  74. all<T1, T2, T3, T4, T5, T6, T7>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]): Promise<[T1, T2, T3, T4, T5, T6, T7]>;
  75. /**
  76. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  77. * resolve, or rejected when any Promise is rejected.
  78. * @param values An array of Promises.
  79. * @returns A new Promise.
  80. */
  81. all<T1, T2, T3, T4, T5, T6>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]): Promise<[T1, T2, T3, T4, T5, T6]>;
  82. /**
  83. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  84. * resolve, or rejected when any Promise is rejected.
  85. * @param values An array of Promises.
  86. * @returns A new Promise.
  87. */
  88. all<T1, T2, T3, T4, T5>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]): Promise<[T1, T2, T3, T4, T5]>;
  89. /**
  90. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  91. * resolve, or rejected when any Promise is rejected.
  92. * @param values An array of Promises.
  93. * @returns A new Promise.
  94. */
  95. all<T1, T2, T3, T4>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]): Promise<[T1, T2, T3, T4]>;
  96. /**
  97. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  98. * resolve, or rejected when any Promise is rejected.
  99. * @param values An array of Promises.
  100. * @returns A new Promise.
  101. */
  102. all<T1, T2, T3>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]): Promise<[T1, T2, T3]>;
  103. /**
  104. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  105. * resolve, or rejected when any Promise is rejected.
  106. * @param values An array of Promises.
  107. * @returns A new Promise.
  108. */
  109. all<T1, T2>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]): Promise<[T1, T2]>;
  110. /**
  111. * Creates a Promise that is resolved with an array of results when all of the provided Promises
  112. * resolve, or rejected when any Promise is rejected.
  113. * @param values An array of Promises.
  114. * @returns A new Promise.
  115. */
  116. all<T>(values: (T | PromiseLike<T>)[]): Promise<T[]>;
  117. /**
  118. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  119. * or rejected.
  120. * @param values An array of Promises.
  121. * @returns A new Promise.
  122. */
  123. race<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]): Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10>;
  124. /**
  125. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  126. * or rejected.
  127. * @param values An array of Promises.
  128. * @returns A new Promise.
  129. */
  130. race<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]): Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>;
  131. /**
  132. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  133. * or rejected.
  134. * @param values An array of Promises.
  135. * @returns A new Promise.
  136. */
  137. race<T1, T2, T3, T4, T5, T6, T7, T8>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]): Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>;
  138. /**
  139. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  140. * or rejected.
  141. * @param values An array of Promises.
  142. * @returns A new Promise.
  143. */
  144. race<T1, T2, T3, T4, T5, T6, T7>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]): Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7>;
  145. /**
  146. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  147. * or rejected.
  148. * @param values An array of Promises.
  149. * @returns A new Promise.
  150. */
  151. race<T1, T2, T3, T4, T5, T6>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]): Promise<T1 | T2 | T3 | T4 | T5 | T6>;
  152. /**
  153. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  154. * or rejected.
  155. * @param values An array of Promises.
  156. * @returns A new Promise.
  157. */
  158. race<T1, T2, T3, T4, T5>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]): Promise<T1 | T2 | T3 | T4 | T5>;
  159. /**
  160. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  161. * or rejected.
  162. * @param values An array of Promises.
  163. * @returns A new Promise.
  164. */
  165. race<T1, T2, T3, T4>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]): Promise<T1 | T2 | T3 | T4>;
  166. /**
  167. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  168. * or rejected.
  169. * @param values An array of Promises.
  170. * @returns A new Promise.
  171. */
  172. race<T1, T2, T3>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]): Promise<T1 | T2 | T3>;
  173. /**
  174. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  175. * or rejected.
  176. * @param values An array of Promises.
  177. * @returns A new Promise.
  178. */
  179. race<T1, T2>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]): Promise<T1 | T2>;
  180. /**
  181. * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
  182. * or rejected.
  183. * @param values An array of Promises.
  184. * @returns A new Promise.
  185. */
  186. race<T>(values: (T | PromiseLike<T>)[]): Promise<T>;
  187. /**
  188. * Creates a new rejected promise for the provided reason.
  189. * @param reason The reason the promise was rejected.
  190. * @returns A new rejected Promise.
  191. */
  192. reject(reason: any): Promise<never>;
  193. /**
  194. * Creates a new rejected promise for the provided reason.
  195. * @param reason The reason the promise was rejected.
  196. * @returns A new rejected Promise.
  197. */
  198. reject<T>(reason: any): Promise<T>;
  199. /**
  200. * Creates a new resolved promise for the provided value.
  201. * @param value A promise.
  202. * @returns A promise whose internal state matches the provided promise.
  203. */
  204. resolve<T>(value: T | PromiseLike<T>): Promise<T>;
  205. /**
  206. * Creates a new resolved promise .
  207. * @returns A resolved promise.
  208. */
  209. resolve(): Promise<void>;
  210. }
  211. declare const Promise: PromiseConstructor;
  212. export default Promise;