@types/promise-deferred

Installation

npm install --save @types/promise-deferred

Summary

This package contains type definitions for promise-deferred (https://github.com/ljharb/promise-deferred).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/promise-deferred.

index.d.ts

export = DeferredCtor;

/**
 * @example
 * import Deferred = require('promise-deferred');
 * const deferred = new Deferred<string>();
 *
 * // set up handlers
 * deferred.promise.then((value) => {}, (error) => {});
 *
 * // resolve
 * deferred.resolve('a value');
 *
 * // reject
 * deferred.reject(new Error('oh noes'));
 */
declare const DeferredCtor: {
    // eslint-disable-next-line @definitelytyped/no-unnecessary-generics
    <T>(): DeferredCtor.Deferred<T>;
    // eslint-disable-next-line @definitelytyped/no-unnecessary-generics
    new<T>(): DeferredCtor.Deferred<T>;

    Promise: typeof Promise;
};

declare namespace DeferredCtor {
    interface Deferred<T> {
        readonly promise: Promise<T>;
        resolve(value: T | PromiseLike<T>): void;
        reject(reason?: any): void;
    }
}

Additional Details

• Last updated: Tue, 07 Nov 2023 0939 GMT
• Dependencies: none

Credits

These definitions were written by BendingBender.