race-cancellation
Version:
Utilities for using Promise.race([task, cancellation]) for async/await code.
10 lines • 637 B
TypeScript
import { DisposableExecutorFn, RaceCancelFn } from "./interfaces.js";
/**
* Creates a cancellable Promise from an executor that returns a {@link DisposeFn} function and a {@link RaceCancelFn} function.
*
* @param disposableExecutor - a {@link DisposableExecutorFn} function (this will not be run if already cancelled).
* @param raceCancel - a {@link RaceCancelFn} function to race against the disposable promise against.
* @public
*/
export default function cancellablePromise<TResult>(disposableExecutor: DisposableExecutorFn<TResult>, raceCancel?: RaceCancelFn): Promise<TResult>;
//# sourceMappingURL=cancellablePromise.d.ts.map