race-cancellation/dist/withCancel.js

Utilities for using Promise.race([task, cancellation]) for async/await code.

import composeRaceCancel from "./composeRaceCancel.js";
import newRaceCancel from "./newRaceCancel.js";
/**
 * Run a {@link CancellableAsyncFn} function with a {@link RaceCancelFn} adapted from a {@link DisposableCancelExecutorFn} function.
 *
 * @param cancellableAsync - a {@link CancellableAsyncFn} function
 * @param disposableCancelExecutor - a {@link DisposableCancelExecutorFn} function that will only be called once
 * @param outerRaceCancel - an optional outer {@link RaceCancelFn} function that will be composed with the {@link RaceCancelFn} function before being passed to the {@link CancellableAsyncFn} function.
 * @public
 */
export default async function withCancel(cancellableAsync, disposableCancelExecutor, outerRaceCancel) {
    let cancelled = false;
    let cancelReason;
    let dispose;
    const raceCancel = newRaceCancel(() => cancelled, (resolveCancel) => {
        dispose = disposableCancelExecutor((reason) => {
            cancelled = true;
            cancelReason = reason;
            resolveCancel();
        });
    }, () => cancelReason);
    let result;
    try {
        result = await cancellableAsync(composeRaceCancel(raceCancel, outerRaceCancel));
    }
    finally {
        if (dispose !== undefined) {
            dispose();
        }
    }
    return result;
}
//# sourceMappingURL=withCancel.js.map