// Type definitions for bluebird 3.5 // Project: https://github.com/petkaantonov/bluebird // Definitions by: Leonard Hecker // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 3.2 /*! * The code following this comment originates from: * https://github.com/types/npm-bluebird * * Note for browser users: use bluebird-global typings instead of this one * if you want to use Bluebird via the global Promise symbol. * * Licensed under: * The MIT License (MIT) * * Copyright (c) 2016 unional * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ type Constructor = new (...args: any[]) => E; type CatchFilter = ((error: E) => boolean) | (object & E); type Resolvable = R | PromiseLike; type IterateFunction = (item: T, index: number, arrayLength: number) => Resolvable; declare class Bluebird implements PromiseLike, Bluebird.Inspection { readonly [Symbol.toStringTag]: "Object"; /** * Create a new promise. The passed in function will receive functions * `resolve` and `reject` as its arguments which can be called to seal the fate of the created promise. * * If promise cancellation is enabled, passed in function will receive * one more function argument `onCancel` that allows to register an optional cancellation callback. */ constructor(callback: (resolve: (thenableOrResult?: Resolvable) => void, reject: (error?: any) => void, onCancel?: (callback: () => void) => void) => void); /** * Promises/A+ `.then()`. Returns a new promise chained from this promise. * * The new promise will be rejected or resolved depending on the passed `fulfilledHandler`, `rejectedHandler` and the state of this promise. */ // Based on PromiseLike.then, but returns a Bluebird instance. then(onFulfill?: (value: R) => Resolvable, onReject?: (error: any) => Resolvable): Bluebird; // For simpler signature help. then( onfulfilled?: ((value: R) => Resolvable) | null, onrejected?: ((reason: any) => Resolvable) | null ): Bluebird; /** * This is a catch-all exception handler, shortcut for calling `.then(null, handler)` on this promise. * * Any exception happening in a `.then`-chain will propagate to nearest `.catch` handler. * * Alias `.caught();` for compatibility with earlier ECMAScript version. */ catch(onReject: ((error: any) => Resolvable) | undefined | null): Bluebird; /** * This extends `.catch` to work more like catch-clauses in languages like Java or C#. * * Instead of manually checking `instanceof` or `.name === "SomeError"`, * you may specify a number of error constructors which are eligible for this catch handler. * The catch handler that is first met that has eligible constructors specified, is the one that will be called. * * This method also supports predicate-based filters. * If you pass a predicate function instead of an error constructor, the predicate will receive the error as an argument. * The return result of the predicate will be used determine whether the error handler should be called. * * Alias `.caught();` for compatibility with earlier ECMAScript version. */ catch( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, filter5: Constructor, onReject: (error: E1 | E2 | E3 | E4 | E5) => Resolvable, ): Bluebird; catch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, filter5: Constructor | CatchFilter, onReject: (error: E1 | E2 | E3 | E4 | E5) => Resolvable, ): Bluebird; catch( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, onReject: (error: E1 | E2 | E3 | E4) => Resolvable, ): Bluebird; catch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, onReject: (error: E1 | E2 | E3 | E4) => Resolvable, ): Bluebird; catch( filter1: Constructor, filter2: Constructor, filter3: Constructor, onReject: (error: E1 | E2 | E3) => Resolvable, ): Bluebird; catch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, onReject: (error: E1 | E2 | E3) => Resolvable, ): Bluebird; catch( filter1: Constructor, filter2: Constructor, onReject: (error: E1 | E2) => Resolvable, ): Bluebird; catch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, onReject: (error: E1 | E2) => Resolvable, ): Bluebird; catch( filter1: Constructor, onReject: (error: E1) => Resolvable, ): Bluebird; catch( // tslint:disable-next-line:unified-signatures filter1: Constructor | CatchFilter, onReject: (error: E1) => Resolvable, ): Bluebird; /** * This is a catch-all exception handler, shortcut for calling `.then(null, handler)` on this promise. * * Any exception happening in a `.then`-chain will propagate to nearest `.catch` handler. * * Alias `.caught();` for compatibility with earlier ECMAScript version. */ caught: Bluebird["catch"]; /** * Like `.catch` but instead of catching all types of exceptions, * it only catches those that don't originate from thrown errors but rather from explicit rejections. */ error(onReject: (reason: any) => Resolvable): Bluebird; /** * Pass a handler that will be called regardless of this promise's fate. Returns a new promise chained from this promise. * * There are special semantics for `.finally()` in that the final value cannot be modified from the handler. * * Alias `.lastly();` for compatibility with earlier ECMAScript version. */ finally(handler: () => Resolvable): Bluebird; lastly: Bluebird["finally"]; /** * Create a promise that follows this promise, but is bound to the given `thisArg` value. * A bound promise will call its handlers with the bound value set to `this`. * * Additionally promises derived from a bound promise will also be bound promises with the same `thisArg` binding as the original promise. */ bind(thisArg: any): Bluebird; /** * Like `.then()`, but any unhandled rejection that ends up here will be thrown as an error. */ done(onFulfilled?: (value: R) => Resolvable, onRejected?: (error: any) => Resolvable): void; /** * Like `.finally()`, but not called for rejections. */ tap(onFulFill: (value: R) => Resolvable): Bluebird; /** * Like `.catch()` but rethrows the error */ tapCatch(onReject: (error?: any) => Resolvable): Bluebird; tapCatch( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, filter5: Constructor, onReject: (error: E1 | E2 | E3 | E4 | E5) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, filter5: Constructor | CatchFilter, onReject: (error: E1 | E2 | E3 | E4 | E5) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, onReject: (error: E1 | E2 | E3 | E4) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, onReject: (error: E1 | E2 | E3 | E4) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor, filter2: Constructor, filter3: Constructor, onReject: (error: E1 | E2 | E3) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, onReject: (error: E1 | E2 | E3) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor, filter2: Constructor, onReject: (error: E1 | E2) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, onReject: (error: E1 | E2) => Resolvable, ): Bluebird; tapCatch( filter1: Constructor, onReject: (error: E1) => Resolvable, ): Bluebird; tapCatch( // tslint:disable-next-line:unified-signatures filter1: Constructor | CatchFilter, onReject: (error: E1) => Resolvable, ): Bluebird; /** * Same as calling `Promise.delay(ms, this)`. */ delay(ms: number): Bluebird; /** * Returns a promise that will be fulfilled with this promise's fulfillment value or rejection reason. * However, if this promise is not fulfilled or rejected within ms milliseconds, the returned promise * is rejected with a TimeoutError or the error as the reason. * * You may specify a custom error message with the `message` parameter. */ timeout(ms: number, message?: string | Error): Bluebird; /** * Register a node-style callback on this promise. * * When this promise is is either fulfilled or rejected, * the node callback will be called back with the node.js convention * where error reason is the first argument and success value is the second argument. * * The error argument will be `null` in case of success. * If the `callback` argument is not a function, this method does not do anything. */ nodeify(callback: (err: any, value?: R) => void, options?: Bluebird.SpreadOption): this; nodeify(...sink: any[]): this; asCallback(callback: (err: any, value?: R) => void, options?: Bluebird.SpreadOption): this; asCallback(...sink: any[]): this; /** * See if this `promise` has been fulfilled. */ isFulfilled(): boolean; /** * See if this `promise` has been rejected. */ isRejected(): boolean; /** * See if this `promise` is still defer. */ isPending(): boolean; /** * See if this `promise` has been cancelled. */ isCancelled(): boolean; /** * See if this `promise` is resolved -> either fulfilled or rejected. */ isResolved(): boolean; /** * Get the fulfillment value of the underlying promise. Throws if the promise isn't fulfilled yet. * * throws `TypeError` */ value(): R; /** * Get the rejection reason for the underlying promise. Throws if the promise isn't rejected yet. * * throws `TypeError` */ reason(): any; /** * Synchronously inspect the state of this `promise`. The `PromiseInspection` will represent the state of * the promise as snapshotted at the time of calling `.reflect()`. */ reflect(): Bluebird>; /** * This is a convenience method for doing: * * * promise.then(function(obj){ * return obj[propertyName].call(obj, arg...); * }); * */ call(this: Bluebird, propertyName: U, ...args: any[]): Bluebird any ? ReturnType : never>; /** * This is a convenience method for doing: * * * promise.then(function(obj){ * return obj[propertyName]; * }); * */ get(key: U): Bluebird; /** * Convenience method for: * * * .then(function() { * return value; * }); * * * in the case where `value` doesn't change its value. That means `value` is bound at the time of calling `.return()` * * Alias `.thenReturn();` for compatibility with earlier ECMAScript version. */ return(): Bluebird; return(value: U): Bluebird; thenReturn(): Bluebird; thenReturn(value: U): Bluebird; /** * Convenience method for: * * * .then(function() { * throw reason; * }); * * Same limitations apply as with `.return()`. * * Alias `.thenThrow();` for compatibility with earlier ECMAScript version. */ throw(reason: Error): Bluebird; thenThrow(reason: Error): Bluebird; /** * Convenience method for: * * * .catch(function() { * return value; * }); * * * in the case where `value` doesn't change its value. That means `value` is bound at the time of calling `.catchReturn()` */ catchReturn(value: U): Bluebird; // No need to be specific about Error types in these overrides, since there's no handler function catchReturn( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, filter5: Constructor, value: U, ): Bluebird; catchReturn( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, filter5: Constructor | CatchFilter, value: U, ): Bluebird; catchReturn( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, value: U, ): Bluebird; catchReturn( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, value: U, ): Bluebird; catchReturn( filter1: Constructor, filter2: Constructor, filter3: Constructor, value: U, ): Bluebird; catchReturn( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, value: U, ): Bluebird; catchReturn( filter1: Constructor, filter2: Constructor, value: U, ): Bluebird; catchReturn( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, value: U, ): Bluebird; catchReturn( filter1: Constructor, value: U, ): Bluebird; catchReturn( // tslint:disable-next-line:unified-signatures filter1: Constructor | CatchFilter, value: U, ): Bluebird; /** * Convenience method for: * * * .catch(function() { * throw reason; * }); * * Same limitations apply as with `.catchReturn()`. */ catchThrow(reason: Error): Bluebird; // No need to be specific about Error types in these overrides, since there's no handler function catchThrow( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, filter5: Constructor, reason: Error, ): Bluebird; catchThrow( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, filter5: Constructor | CatchFilter, reason: Error, ): Bluebird; catchThrow( filter1: Constructor, filter2: Constructor, filter3: Constructor, filter4: Constructor, reason: Error, ): Bluebird; catchThrow( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, filter4: Constructor | CatchFilter, reason: Error, ): Bluebird; catchThrow( filter1: Constructor, filter2: Constructor, filter3: Constructor, reason: Error, ): Bluebird; catchThrow( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, filter3: Constructor | CatchFilter, reason: Error, ): Bluebird; catchThrow( filter1: Constructor, filter2: Constructor, reason: Error, ): Bluebird; catchThrow( filter1: Constructor | CatchFilter, filter2: Constructor | CatchFilter, reason: Error, ): Bluebird; catchThrow( filter1: Constructor, reason: Error, ): Bluebird; catchThrow( // tslint:disable-next-line:unified-signatures filter1: Constructor | CatchFilter, reason: Error, ): Bluebird; /** * Convert to String. */ toString(): string; /** * This is implicitly called by `JSON.stringify` when serializing the object. Returns a serialized representation of the `Promise`. */ toJSON(): object; /** * Like calling `.then`, but the fulfillment value or rejection reason is assumed to be an array, which is flattened to the formal parameters of the handlers. */ spread(this: Bluebird>, fulfilledHandler: (...values: Q[]) => Resolvable): Bluebird; /** * Same as calling `Promise.all(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ all(this: Bluebird<[Resolvable, Resolvable, Resolvable, Resolvable, Resolvable]>): Bluebird<[T1, T2, T3, T4, T5]>; all(this: Bluebird<[Resolvable, Resolvable, Resolvable, Resolvable]>): Bluebird<[T1, T2, T3, T4]>; all(this: Bluebird<[Resolvable, Resolvable, Resolvable]>): Bluebird<[T1, T2, T3]>; all(this: Bluebird<[Resolvable, Resolvable]>): Bluebird<[T1, T2]>; all(this: Bluebird<[Resolvable]>): Bluebird<[T1]>; all(this: Bluebird>>): Bluebird; /** * Same as calling `Promise.all(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ all(): Bluebird; /** * Same as calling `Promise.props(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ props(this: PromiseLike>>): Bluebird>; props(this: PromiseLike>): Bluebird; /** * Same as calling `Promise.any(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ any(this: Bluebird>): Bluebird; /** * Same as calling `Promise.any(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ any(): Bluebird; /** * Same as calling `Promise.some(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. * Same as calling `Promise.some(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ some(this: Bluebird>, count: number): Bluebird; /** * Same as calling `Promise.some(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. * Same as calling `Promise.some(thisPromise)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ some(count: number): Bluebird; /** * Same as calling `Promise.race(thisPromise, count)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ race(this: Bluebird>): Bluebird; /** * Same as calling `Promise.race(thisPromise, count)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ race(): Bluebird; /** * Same as calling `Bluebird.map(thisPromise, mapper)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ map(this: Bluebird>, mapper: IterateFunction, options?: Bluebird.ConcurrencyOption): Bluebird; /** * Same as calling `Promise.reduce(thisPromise, Function reducer, initialValue)`. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ reduce(this: Bluebird>, reducer: (memo: U, item: Q, index: number, arrayLength: number) => Resolvable, initialValue?: U): Bluebird; /** * Same as calling ``Promise.filter(thisPromise, filterer)``. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ filter(this: Bluebird>, filterer: IterateFunction, options?: Bluebird.ConcurrencyOption): Bluebird; /** * Same as calling ``Bluebird.each(thisPromise, iterator)``. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ each(this: Bluebird>, iterator: IterateFunction): Bluebird; /** * Same as calling ``Bluebird.mapSeries(thisPromise, iterator)``. With the exception that if this promise is bound to a value, the returned promise is bound to that value too. */ mapSeries(this: Bluebird>, iterator: IterateFunction): Bluebird; /** * Cancel this `promise`. Will not do anything if this promise is already settled or if the cancellation feature has not been enabled */ cancel(): void; /** * Basically sugar for doing: somePromise.catch(function(){}); * * Which is needed in case error handlers are attached asynchronously to the promise later, which would otherwise result in premature unhandled rejection reporting. */ suppressUnhandledRejections(): void; /** * Start the chain of promises with `Promise.try`. Any synchronous exceptions will be turned into rejections on the returned promise. * * Note about second argument: if it's specifically a true array, its values become respective arguments for the function call. * Otherwise it is passed as is as the first argument for the function call. * * Alias for `attempt();` for compatibility with earlier ECMAScript version. */ static try(fn: () => Resolvable): Bluebird; static attempt(fn: () => Resolvable): Bluebird; /** * Returns a new function that wraps the given function `fn`. * The new function will always return a promise that is fulfilled with the original functions return values or rejected with thrown exceptions from the original function. * This method is convenient when a function can sometimes return synchronously or throw synchronously. */ static method(fn: () => Resolvable): () => Bluebird; static method(fn: (arg1: A1) => Resolvable): (arg1: A1) => Bluebird; static method(fn: (arg1: A1, arg2: A2) => Resolvable): (arg1: A1, arg2: A2) => Bluebird; static method(fn: (arg1: A1, arg2: A2, arg3: A3) => Resolvable): (arg1: A1, arg2: A2, arg3: A3) => Bluebird; static method(fn: (arg1: A1, arg2: A2, arg3: A3, arg4: A4) => Resolvable): (arg1: A1, arg2: A2, arg3: A3, arg4: A4) => Bluebird; static method(fn: (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5) => Resolvable): (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5) => Bluebird; static method(fn: (...args: any[]) => Resolvable): (...args: any[]) => Bluebird; /** * Create a promise that is resolved with the given `value`. If `value` is a thenable or promise, the returned promise will assume its state. */ static resolve(): Bluebird; static resolve(value: Resolvable): Bluebird; /** * Create a promise that is rejected with the given `reason`. */ static reject(reason: any): Bluebird; /** * @deprecated * Create a promise with undecided fate and return a `PromiseResolver` to control it. See resolution?: Promise(#promise-resolution). * @see http://bluebirdjs.com/docs/deprecated-apis.html#promise-resolution */ static defer(): Bluebird.Resolver; /** * Cast the given `value` to a trusted promise. * * If `value` is already a trusted `Promise`, it is returned as is. If `value` is not a thenable, a fulfilled is: Promise returned with `value` as its fulfillment value. * If `value` is a thenable (Promise-like object, like those returned by jQuery's `$.ajax`), returns a trusted that: Promise assimilates the state of the thenable. */ static cast(value: Resolvable): Bluebird; /** * Sugar for `Promise.resolve(undefined).bind(thisArg);`. See `.bind()`. */ static bind(thisArg: any): Bluebird; /** * See if `value` is a trusted Promise. */ static is(value: any): boolean; /** * Call this right after the library is loaded to enabled long stack traces. * * Long stack traces cannot be disabled after being enabled, and cannot be enabled after promises have already been created. * Long stack traces imply a substantial performance penalty, around 4-5x for throughput and 0.5x for latency. */ static longStackTraces(): void; /** * Returns a promise that will be resolved with value (or undefined) after given ms milliseconds. * If value is a promise, the delay will start counting down when it is fulfilled and the returned * promise will be fulfilled with the fulfillment value of the value promise. */ static delay(ms: number, value: Resolvable): Bluebird; static delay(ms: number): Bluebird; /** * Returns a function that will wrap the given `nodeFunction`. * * Instead of taking a callback, the returned function will return a promise whose fate is decided by the callback behavior of the given node function. * The node function should conform to node.js convention of accepting a callback as last argument and * calling that callback with error as the first argument and success value on the second argument. * * If the `nodeFunction` calls its callback with multiple success values, the fulfillment value will be an array of them. * * If you pass a `receiver`, the `nodeFunction` will be called as a method on the `receiver`. */ static promisify( func: (callback: (err: any, result?: T) => void) => void, options?: Bluebird.PromisifyOptions ): () => Bluebird; static promisify( func: (arg1: A1, callback: (err: any, result?: T) => void) => void, options?: Bluebird.PromisifyOptions ): (arg1: A1) => Bluebird; static promisify( func: (arg1: A1, arg2: A2, callback: (err: any, result?: T) => void) => void, options?: Bluebird.PromisifyOptions ): (arg1: A1, arg2: A2) => Bluebird; static promisify( func: (arg1: A1, arg2: A2, arg3: A3, callback: (err: any, result?: T) => void) => void, options?: Bluebird.PromisifyOptions ): (arg1: A1, arg2: A2, arg3: A3) => Bluebird; static promisify( func: (arg1: A1, arg2: A2, arg3: A3, arg4: A4, callback: (err: any, result?: T) => void) => void, options?: Bluebird.PromisifyOptions ): (arg1: A1, arg2: A2, arg3: A3, arg4: A4) => Bluebird; static promisify( func: (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, callback: (err: any, result?: T) => void) => void, options?: Bluebird.PromisifyOptions ): (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5) => Bluebird; static promisify(nodeFunction: (...args: any[]) => void, options?: Bluebird.PromisifyOptions): (...args: any[]) => Bluebird; /** * Promisifies the entire object by going through the object's properties and creating an async equivalent of each function on the object and its prototype chain. * * The promisified method name will be the original method name postfixed with `Async`. Returns the input object. * * Note that the original methods on the object are not overwritten but new methods are created with the `Async`-postfix. For example, * if you `promisifyAll()` the node.js `fs` object use `fs.statAsync()` to call the promisified `stat` method. */ // TODO how to model promisifyAll? static promisifyAll(target: T, options?: Bluebird.PromisifyAllOptions): T; /** * Returns a promise that is resolved by a node style callback function. */ static fromNode(resolver: (callback: (err: any, result?: T) => void) => void, options?: Bluebird.FromNodeOptions): Bluebird; static fromCallback(resolver: (callback: (err: any, result?: T) => void) => void, options?: Bluebird.FromNodeOptions): Bluebird; /** * Returns a function that can use `yield` to run asynchronous code synchronously. * * This feature requires the support of generators which are drafted in the next version of the language. * Node version greater than `0.11.2` is required and needs to be executed with the `--harmony-generators` (or `--harmony`) command-line switch. */ // TODO: After https://github.com/Microsoft/TypeScript/issues/2983 is implemented, we can use // the return type propagation of generators to automatically infer the return type T. static coroutine( generatorFunction: () => IterableIterator, options?: Bluebird.CoroutineOptions ): () => Bluebird; static coroutine( generatorFunction: (a1: A1) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2, a3: A3) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2, a3: A3) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2, a3: A3, a4: A4) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2, a3: A3, a4: A4) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => Bluebird; static coroutine( generatorFunction: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => IterableIterator, options?: Bluebird.CoroutineOptions ): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => Bluebird; /** * Add `handler` as the handler to call when there is a possibly unhandled rejection. The default handler logs the error stack to stderr or `console.error` in browsers. * * Passing no value or a non-function will have the effect of removing any kind of handling for possibly unhandled rejections. */ static onPossiblyUnhandledRejection(handler: (reason: any) => any): void; /** * Add handler as the handler to call when there is a possibly unhandled rejection. * The default handler logs the error stack to stderr or console.error in browsers. * * Passing no value or a non-function will have the effect of removing any kind of handling for possibly unhandled rejections. * * Note: this hook is specific to the bluebird instance its called on, application developers should use global rejection events. */ static onPossiblyUnhandledRejection(handler?: (error: Error, promise: Bluebird) => void): void; /** * Given an array, or a promise of an array, which contains promises (or a mix of promises and values) return a promise that is fulfilled when all the items in the array are fulfilled. * The promise's fulfillment value is an array with fulfillment values at respective positions to the original array. * If any promise in the array rejects, the returned promise is rejected with the rejection reason. */ // TODO enable more overloads // array with promises of different types static all(values: [Resolvable, Resolvable, Resolvable, Resolvable, Resolvable]): Bluebird<[T1, T2, T3, T4, T5]>; static all(values: [Resolvable, Resolvable, Resolvable, Resolvable]): Bluebird<[T1, T2, T3, T4]>; static all(values: [Resolvable, Resolvable, Resolvable]): Bluebird<[T1, T2, T3]>; static all(values: [Resolvable, Resolvable]): Bluebird<[T1, T2]>; static all(values: [Resolvable]): Bluebird<[T1]>; // array with values static all(values: Resolvable>>): Bluebird; static allSettled(values: [Resolvable, Resolvable, Resolvable, Resolvable, Resolvable]): Bluebird<[Bluebird.Inspection, Bluebird.Inspection, Bluebird.Inspection, Bluebird.Inspection, Bluebird.Inspection]>; static allSettled(values: [Resolvable, Resolvable, Resolvable, Resolvable]): Bluebird<[Bluebird.Inspection, Bluebird.Inspection, Bluebird.Inspection, Bluebird.Inspection]>; static allSettled(values: [Resolvable, Resolvable, Resolvable]): Bluebird<[Bluebird.Inspection, Bluebird.Inspection, Bluebird.Inspection]>; static allSettled(values: [Resolvable, Resolvable]): Bluebird<[Bluebird.Inspection, Bluebird.Inspection]>; static allSettled(values: [Resolvable]): Bluebird<[Bluebird.Inspection]>; static allSettled(values: Resolvable>>): Bluebird>>; /** * Like ``Promise.all`` but for object properties instead of array items. Returns a promise that is fulfilled when all the properties of the object are fulfilled. * * The promise's fulfillment value is an object with fulfillment values at respective keys to the original object. * If any promise in the object rejects, the returned promise is rejected with the rejection reason. * * If `object` is a trusted `Promise`, then it will be treated as a promise for object rather than for its properties. * All other objects are treated for their properties as is returned by `Object.keys` - the object's own enumerable properties. * * *The original object is not modified.* */ // map static props(map: Resolvable>>): Bluebird>; // trusted promise for object static props(object: PromiseLike>): Bluebird; // object static props(object: Bluebird.ResolvableProps): Bluebird; // tslint:disable-line:unified-signatures /** * Like `Promise.some()`, with 1 as `count`. However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly. */ static any(values: Resolvable>>): Bluebird; /** * Given an array, or a promise of an array, which contains promises (or a mix of promises and values) return a promise that is * fulfilled or rejected as soon as a promise in the array is fulfilled or rejected with the respective rejection reason or fulfillment value. * * **Note** If you pass empty array or a sparse array with no values, or a promise/thenable for such, it will be forever pending. */ static race(values: Resolvable>>): Bluebird; /** * Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises). * When `count` amount of promises have been fulfilled, the returned promise is fulfilled with an array that contains the fulfillment values of * the winners in order of resolution. * * If too many promises are rejected so that the promise can never become fulfilled, * it will be immediately rejected with an array of rejection reasons in the order they were thrown in. * * *The original array is not modified.* */ static some(values: Resolvable>>, count: number): Bluebird; /** * Promise.join( * Promise|any values..., * function handler * ) -> Promise * For coordinating multiple concurrent discrete promises. * * Note: In 1.x and 0.x Promise.join used to be a Promise.all that took the values in as arguments instead in an array. * This behavior has been deprecated but is still supported partially - when the last argument is an immediate function value the new semantics will apply */ static join( arg1: Resolvable, handler: (arg1: A1) => Resolvable ): Bluebird; static join( arg1: Resolvable, arg2: Resolvable, handler: (arg1: A1, arg2: A2) => Resolvable ): Bluebird; static join( arg1: Resolvable, arg2: Resolvable, arg3: Resolvable, handler: (arg1: A1, arg2: A2, arg3: A3) => Resolvable ): Bluebird; static join( arg1: Resolvable, arg2: Resolvable, arg3: Resolvable, arg4: Resolvable, handler: (arg1: A1, arg2: A2, arg3: A3, arg4: A4) => Resolvable ): Bluebird; static join( arg1: Resolvable, arg2: Resolvable, arg3: Resolvable, arg4: Resolvable, arg5: Resolvable, handler: (arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5) => Resolvable ): Bluebird; // variadic array /** @deprecated use .all instead */ static join(...values: Array>): Bluebird; /** * Map an array, or a promise of an array, * which contains a promises (or a mix of promises and values) with the given `mapper` function with the signature `(item, index, arrayLength)` * where `item` is the resolved value of a respective promise in the input array. * If any promise in the input array is rejected the returned promise is rejected as well. * * If the `mapper` function returns promises or thenables, the returned promise will wait for all the mapped results to be resolved as well. * * *The original array is not modified.* */ static map( values: Resolvable>>, mapper: IterateFunction, options?: Bluebird.ConcurrencyOption ): Bluebird; /** * Reduce an array, or a promise of an array, * which contains a promises (or a mix of promises and values) with the given `reducer` function with the signature `(total, current, index, arrayLength)` * where `item` is the resolved value of a respective promise in the input array. * If any promise in the input array is rejected the returned promise is rejected as well. * * If the reducer function returns a promise or a thenable, the result for the promise is awaited for before continuing with next iteration. * * *The original array is not modified. If no `initialValue` is given and the array doesn't contain at least 2 items, * the callback will not be called and `undefined` is returned. * * If `initialValue` is given and the array doesn't have at least 1 item, `initialValue` is returned.* */ static reduce( values: Resolvable>>, reducer: (total: U, current: R, index: number, arrayLength: number) => Resolvable, initialValue?: U ): Bluebird; /** * Filter an array, or a promise of an array, * which contains a promises (or a mix of promises and values) with the given `filterer` function with the signature `(item, index, arrayLength)` * where `item` is the resolved value of a respective promise in the input array. * If any promise in the input array is rejected the returned promise is rejected as well. * * The return values from the filtered functions are coerced to booleans, with the exception of promises and thenables which are awaited for their eventual result. * * *The original array is not modified. */ static filter( values: Resolvable>>, filterer: IterateFunction, option?: Bluebird.ConcurrencyOption ): Bluebird; /** * Iterate over an array, or a promise of an array, * which contains promises (or a mix of promises and values) with the given iterator function with the signature `(item, index, value)` * where item is the resolved value of a respective promise in the input array. * Iteration happens serially. If any promise in the input array is rejected the returned promise is rejected as well. * * Resolves to the original array unmodified, this method is meant to be used for side effects. * If the iterator function returns a promise or a thenable, the result for the promise is awaited for before continuing with next iteration. */ static each( values: Resolvable>>, iterator: IterateFunction ): Bluebird; /** * Given an Iterable(arrays are Iterable), or a promise of an Iterable, which produces promises (or a mix of promises and values), * iterate over all the values in the Iterable into an array and iterate over the array serially, in-order. * * Returns a promise for an array that contains the values returned by the iterator function in their respective positions. * The iterator won't be called for an item until its previous item, and the promise returned by the iterator for that item are fulfilled. * This results in a mapSeries kind of utility but it can also be used simply as a side effect iterator similar to Array#forEach. * * If any promise in the input array is rejected or any promise returned by the iterator function is rejected, the result will be rejected as well. */ static mapSeries( values: Resolvable>>, iterator: IterateFunction ): Bluebird; /** * A meta method used to specify the disposer method that cleans up a resource when using `Promise.using`. * * Returns a Disposer object which encapsulates both the resource as well as the method to clean it up. * The user can pass this object to `Promise.using` to get access to the resource when it becomes available, * as well as to ensure its automatically cleaned up. * * The second argument passed to a disposer is the result promise of the using block, which you can * inspect synchronously. */ disposer(disposeFn: (arg: R, promise: Bluebird) => Resolvable): Bluebird.Disposer; /** * In conjunction with `.disposer`, using will make sure that no matter what, the specified disposer * will be called when the promise returned by the callback passed to using has settled. The disposer is * necessary because there is no standard interface in node for disposing resources. */ static using( disposer: Bluebird.Disposer, executor: (transaction: R) => PromiseLike ): Bluebird; static using( disposer: Bluebird.Disposer, disposer2: Bluebird.Disposer, executor: (transaction1: R1, transaction2: R2 ) => PromiseLike): Bluebird; static using( disposer: Bluebird.Disposer, disposer2: Bluebird.Disposer, disposer3: Bluebird.Disposer, executor: (transaction1: R1, transaction2: R2, transaction3: R3) => PromiseLike ): Bluebird; /** * Configure long stack traces, warnings, monitoring and cancellation. * Note that even though false is the default here, a development environment might be detected which automatically * enables long stack traces and warnings. */ static config(options: { /** Enable warnings */ warnings?: boolean | { /** Enables all warnings except forgotten return statements. */ wForgottenReturn: boolean; }; /** Enable long stack traces */ longStackTraces?: boolean; /** Enable cancellation */ cancellation?: boolean; /** Enable monitoring */ monitoring?: boolean; }): void; /** * Create a new promise. The passed in function will receive functions `resolve` and `reject` as its arguments which can be called to seal the fate of the created promise. * If promise cancellation is enabled, passed in function will receive one more function argument `onCancel` that allows to register an optional cancellation callback. */ static Promise: typeof Bluebird; /** * The version number of the library */ static version: string; } declare namespace Bluebird { interface ConcurrencyOption { concurrency: number; } interface SpreadOption { spread: boolean; } interface FromNodeOptions { multiArgs?: boolean; } interface PromisifyOptions { context?: any; multiArgs?: boolean; } interface PromisifyAllOptions extends PromisifyOptions { suffix?: string; filter?(name: string, func: (...args: any[]) => any, target?: any, passesDefaultFilter?: boolean): boolean; // The promisifier gets a reference to the original method and should return a function which returns a promise promisifier?(this: T, originalMethod: (...args: any[]) => any, defaultPromisifer: (...args: any[]) => (...args: any[]) => Bluebird): () => PromiseLike; } interface CoroutineOptions { yieldHandler(value: any): any; } /** * Represents an error is an explicit promise rejection as opposed to a thrown error. * For example, if an error is errbacked by a callback API promisified through undefined or undefined * and is not a typed error, it will be converted to a `OperationalError` which has the original error in * the `.cause` property. * * `OperationalError`s are caught in `.error` handlers. */ class OperationalError extends Error { } /** * Signals that an operation has timed out. Used as a custom cancellation reason in `.timeout`. */ class TimeoutError extends Error { } /** * Signals that an operation has been aborted or cancelled. The default reason used by `.cancel`. */ class CancellationError extends Error { } /** * A collection of errors. `AggregateError` is an array-like object, with numeric indices and a `.length` property. * It supports all generic array methods such as `.forEach` directly. * * `AggregateError`s are caught in `.error` handlers, even if the contained errors are not operational. * * `Promise.some` and `Promise.any` use `AggregateError` as rejection reason when they fail. */ class AggregateError extends Error implements ArrayLike { length: number; [index: number]: Error; join(separator?: string): string; pop(): Error; push(...errors: Error[]): number; shift(): Error; unshift(...errors: Error[]): number; slice(begin?: number, end?: number): AggregateError; filter(callback: (element: Error, index: number, array: AggregateError) => boolean, thisArg?: any): AggregateError; forEach(callback: (element: Error, index: number, array: AggregateError) => void, thisArg?: any): undefined; some(callback: (element: Error, index: number, array: AggregateError) => boolean, thisArg?: any): boolean; every(callback: (element: Error, index: number, array: AggregateError) => boolean, thisArg?: any): boolean; map(callback: (element: Error, index: number, array: AggregateError) => boolean, thisArg?: any): AggregateError; indexOf(searchElement: Error, fromIndex?: number): number; lastIndexOf(searchElement: Error, fromIndex?: number): number; reduce(callback: (accumulator: any, element: Error, index: number, array: AggregateError) => any, initialValue?: any): any; reduceRight(callback: (previousValue: any, element: Error, index: number, array: AggregateError) => any, initialValue?: any): any; sort(compareFunction?: (errLeft: Error, errRight: Error) => number): AggregateError; reverse(): AggregateError; } /** * returned by `Bluebird.disposer()`. */ class Disposer { } /** @deprecated Use PromiseLike directly. */ type Thenable = PromiseLike; type ResolvableProps = object & {[K in keyof T]: Resolvable}; interface Resolver { /** * Returns a reference to the controlled promise that can be passed to clients. */ promise: Bluebird; /** * Resolve the underlying promise with `value` as the resolution value. If `value` is a thenable or a promise, the underlying promise will assume its state. */ resolve(value: R): void; resolve(): void; /** * Reject the underlying promise with `reason` as the rejection reason. */ reject(reason: any): void; /** * Gives you a callback representation of the `PromiseResolver`. Note that this is not a method but a property. * The callback accepts error object in first argument and success values on the 2nd parameter and the rest, I.E. node js conventions. * * If the the callback is called with multiple success values, the resolver fulfills its promise with an array of the values. */ // TODO specify resolver callback callback(err: any, value: R, ...values: R[]): void; } interface Inspection { /** * See if the underlying promise was fulfilled at the creation time of this inspection object. */ isFulfilled(): boolean; /** * See if the underlying promise was rejected at the creation time of this inspection object. */ isRejected(): boolean; /** * See if the underlying promise was cancelled at the creation time of this inspection object. */ isCancelled(): boolean; /** * See if the underlying promise was defer at the creation time of this inspection object. */ isPending(): boolean; /** * Get the fulfillment value of the underlying promise. Throws if the promise wasn't fulfilled at the creation time of this inspection object. * * throws `TypeError` */ value(): R; /** * Get the rejection reason for the underlying promise. Throws if the promise wasn't rejected at the creation time of this inspection object. * * throws `TypeError` */ reason(): any; } /** * Returns a new independent copy of the Bluebird library. * * This method should be used before you use any of the methods which would otherwise alter the global Bluebird object - to avoid polluting global state. */ function getNewLibraryCopy(): typeof Bluebird; /** * This is relevant to browser environments with no module loader. * * Release control of the Promise namespace to whatever it was before this library was loaded. * Returns a reference to the library namespace so you can attach it to something else. */ function noConflict(): typeof Bluebird; /** * Changes how bluebird schedules calls a-synchronously. * * @param scheduler Should be a function that asynchronously schedules * the calling of the passed in function */ function setScheduler(scheduler: (callback: (...args: any[]) => void) => void): void; } export = Bluebird;