|
@@ -1,71 +1,238 @@
|
|
|
-// 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
|
|
|
+// ES6 Promises
|
|
|
+// From https://github.com/Microsoft/TypeScript/blob/911d07a81b9348dd576985f263955c8e0968277e/lib/lib.core.es6.d.ts
|
|
|
|
|
|
-interface Thenable<R> {
|
|
|
- then<U>(onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
|
|
|
+/*! *****************************************************************************
|
|
|
+Copyright (c) Microsoft Corporation. All rights reserved.
|
|
|
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
|
|
+this file except in compliance with the License. You may obtain a copy of the
|
|
|
+License at http://www.apache.org/licenses/LICENSE-2.0
|
|
|
+
|
|
|
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
|
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
|
|
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
|
|
+MERCHANTABLITY OR NON-INFRINGEMENT.
|
|
|
+
|
|
|
+See the Apache Version 2.0 License for specific language governing permissions
|
|
|
+and limitations under the License.
|
|
|
+***************************************************************************** */
|
|
|
+
|
|
|
+interface Symbol {
|
|
|
+ /** Returns a string representation of an object. */
|
|
|
+ toString(): string;
|
|
|
+
|
|
|
+ /** Returns the primitive value of the specified object. */
|
|
|
+ valueOf(): Object;
|
|
|
+
|
|
|
+ //[Symbol.toStringTag]: "Symbol";
|
|
|
+}
|
|
|
+
|
|
|
+interface SymbolConstructor {
|
|
|
+ /**
|
|
|
+ * A reference to the prototype.
|
|
|
+ */
|
|
|
+ prototype: Symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Returns a new unique Symbol value.
|
|
|
+ * @param description Description of the new Symbol object.
|
|
|
+ */
|
|
|
+ (description?: string|number): symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Returns a Symbol object from the global symbol registry matching the given key if found.
|
|
|
+ * Otherwise, returns a new symbol with this key.
|
|
|
+ * @param key key to search for.
|
|
|
+ */
|
|
|
+ for(key: string): symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Returns a key from the global symbol registry matching the given Symbol if found.
|
|
|
+ * Otherwise, returns a undefined.
|
|
|
+ * @param sym Symbol to find the key for.
|
|
|
+ */
|
|
|
+ keyFor(sym: symbol): string;
|
|
|
+
|
|
|
+ // Well-known Symbols
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A method that determines if a constructor object recognizes an object as one of the
|
|
|
+ * constructor’s instances. Called by the semantics of the instanceof operator.
|
|
|
+ */
|
|
|
+ hasInstance: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A Boolean value that if true indicates that an object should flatten to its array elements
|
|
|
+ * by Array.prototype.concat.
|
|
|
+ */
|
|
|
+ isConcatSpreadable: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A method that returns the default iterator for an object. Called by the semantics of the
|
|
|
+ * for-of statement.
|
|
|
+ */
|
|
|
+ iterator: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A regular expression method that matches the regular expression against a string. Called
|
|
|
+ * by the String.prototype.match method.
|
|
|
+ */
|
|
|
+ match: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A regular expression method that replaces matched substrings of a string. Called by the
|
|
|
+ * String.prototype.replace method.
|
|
|
+ */
|
|
|
+ replace: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A regular expression method that returns the index within a string that matches the
|
|
|
+ * regular expression. Called by the String.prototype.search method.
|
|
|
+ */
|
|
|
+ search: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A function valued property that is the constructor function that is used to create
|
|
|
+ * derived objects.
|
|
|
+ */
|
|
|
+ species: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A regular expression method that splits a string at the indices that match the regular
|
|
|
+ * expression. Called by the String.prototype.split method.
|
|
|
+ */
|
|
|
+ split: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A method that converts an object to a corresponding primitive value.
|
|
|
+ * Called by the ToPrimitive abstract operation.
|
|
|
+ */
|
|
|
+ toPrimitive: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A String value that is used in the creation of the default string description of an object.
|
|
|
+ * Called by the built-in method Object.prototype.toString.
|
|
|
+ */
|
|
|
+ toStringTag: symbol;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An Object whose own property names are property names that are excluded from the 'with'
|
|
|
+ * environment bindings of the associated objects.
|
|
|
+ */
|
|
|
+ unscopables: symbol;
|
|
|
+}
|
|
|
+declare var Symbol: SymbolConstructor;
|
|
|
+
|
|
|
+interface IteratorResult<T> {
|
|
|
+ done: boolean;
|
|
|
+ value?: T;
|
|
|
+}
|
|
|
+
|
|
|
+interface Iterator<T> {
|
|
|
+ next(value?: any): IteratorResult<T>;
|
|
|
+ return?(value?: any): IteratorResult<T>;
|
|
|
+ throw?(e?: any): IteratorResult<T>;
|
|
|
}
|
|
|
|
|
|
-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 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().
|
|
|
- */
|
|
|
- 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>;
|
|
|
-
|
|
|
- /**
|
|
|
- * Sugar for promise.then(undefined, onRejected)
|
|
|
- *
|
|
|
- * @param onRejected called when/if "promise" rejects
|
|
|
- */
|
|
|
- catch<U>(onRejected?: (error: any) => U | Thenable<U>): Promise<U>;
|
|
|
+interface Iterable<T> {
|
|
|
+ [Symbol.iterator](): Iterator<T>;
|
|
|
}
|
|
|
|
|
|
-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>;
|
|
|
+
|
|
|
+/**
|
|
|
+ * Represents the completion of an asynchronous operation
|
|
|
+ */
|
|
|
+interface Promise<T> {
|
|
|
+ /**
|
|
|
+ * Attaches callbacks for the resolution and/or rejection of the Promise.
|
|
|
+ * @param onfulfilled The callback to execute when the Promise is resolved.
|
|
|
+ * @param onrejected The callback to execute when the Promise is rejected.
|
|
|
+ * @returns A Promise for the completion of which ever callback is executed.
|
|
|
+ */
|
|
|
+ then<TResult>(onfulfilled?: (value: T) => TResult | PromiseLike<TResult>, onrejected?: (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult>;
|
|
|
+ then<TResult>(onfulfilled?: (value: T) => TResult | PromiseLike<TResult>, onrejected?: (reason: any) => void): Promise<TResult>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Attaches a callback for only the rejection of the Promise.
|
|
|
+ * @param onrejected The callback to execute when the Promise is rejected.
|
|
|
+ * @returns A Promise for the completion of the callback.
|
|
|
+ */
|
|
|
+ catch(onrejected?: (reason: any) => T | PromiseLike<T>): Promise<T>;
|
|
|
+ catch(onrejected?: (reason: any) => void): Promise<T>;
|
|
|
+
|
|
|
+ //[Symbol.toStringTag]: "Promise";
|
|
|
}
|
|
|
|
|
|
-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;
|
|
|
+interface PromiseConstructor {
|
|
|
+ /**
|
|
|
+ * A reference to the prototype.
|
|
|
+ */
|
|
|
+ prototype: Promise<any>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a new Promise.
|
|
|
+ * @param executor A callback used to initialize the promise. This callback is passed two arguments:
|
|
|
+ * a resolve callback used resolve the promise with a value or the result of another promise,
|
|
|
+ * and a reject callback used to reject the promise with a provided reason or error.
|
|
|
+ */
|
|
|
+ new <T>(executor: (resolve: (value?: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
|
+ * resolve, or rejected when any Promise is rejected.
|
|
|
+ * @param values An array of Promises.
|
|
|
+ * @returns A new Promise.
|
|
|
+ */
|
|
|
+ all<T1, T2>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]): Promise<[T1, T2]>;
|
|
|
+ all<T1, T2, T3>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]): Promise<[T1, T2, T3]>;
|
|
|
+ all<T1, T2, T3, T4>(values: [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike <T4>]): Promise<[T1, T2, T3, T4]>;
|
|
|
+ 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]>;
|
|
|
+ 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]>;
|
|
|
+ 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]>;
|
|
|
+ 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]>;
|
|
|
+ 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]>;
|
|
|
+ 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]>;
|
|
|
+ all<TAll>(values: Iterable<TAll | PromiseLike<TAll>>): Promise<TAll[]>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
|
|
|
+ * or rejected.
|
|
|
+ * @param values An array of Promises.
|
|
|
+ * @returns A new Promise.
|
|
|
+ */
|
|
|
+ race<T>(values: Iterable<T | PromiseLike<T>>): Promise<T>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a new rejected promise for the provided reason.
|
|
|
+ * @param reason The reason the promise was rejected.
|
|
|
+ * @returns A new rejected Promise.
|
|
|
+ */
|
|
|
+ reject(reason: any): Promise<void>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a new rejected promise for the provided reason.
|
|
|
+ * @param reason The reason the promise was rejected.
|
|
|
+ * @returns A new rejected Promise.
|
|
|
+ */
|
|
|
+ reject<T>(reason: any): Promise<T>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a new resolved promise for the provided value.
|
|
|
+ * @param value A promise.
|
|
|
+ * @returns A promise whose internal state matches the provided promise.
|
|
|
+ */
|
|
|
+ resolve<T>(value: T | PromiseLike<T>): Promise<T>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Creates a new resolved promise .
|
|
|
+ * @returns A resolved promise.
|
|
|
+ */
|
|
|
+ resolve(): Promise<void>;
|
|
|
+
|
|
|
+ [Symbol.species]: Function;
|
|
|
}
|
|
|
+
|
|
|
+declare var Promise: PromiseConstructor;
|
|
|
+
|
|
|
+
|
|
|
+// *just* for jupyter-js-services, which uses a different name.
|
|
|
+declare type Thenable<T> = PromiseLike<T>;
|