p-timeout/index.js

112 lines
2.5 KiB
JavaScript
Raw Normal View History

2021-04-06 17:38:12 +00:00
export class TimeoutError extends Error {
2016-10-21 06:42:17 +00:00
constructor(message) {
super(message);
this.name = 'TimeoutError';
2016-10-21 06:42:17 +00:00
}
}
/**
An error to be thrown when the request is aborted by AbortController.
DOMException is thrown instead of this Error when DOMException is available.
*/
export class AbortError extends Error {
constructor(message) {
super();
this.name = 'AbortError';
this.message = message;
}
}
/**
TODO: Remove AbortError and just throw DOMException when targeting Node 18.
*/
2022-07-25 16:24:32 +00:00
const getDOMException = errorMessage => globalThis.DOMException === undefined
? new AbortError(errorMessage)
: new DOMException(errorMessage);
/**
TODO: Remove below function and just 'reject(signal.reason)' when targeting Node 18.
*/
const getAbortedReason = signal => {
2022-07-25 16:24:32 +00:00
const reason = signal.reason === undefined
? getDOMException('This operation was aborted.')
: signal.reason;
return reason instanceof Error ? reason : getDOMException(reason);
};
export default function pTimeout(promise, options) {
2022-07-25 16:24:32 +00:00
const {
milliseconds,
fallback,
message,
customTimers = {setTimeout, clearTimeout},
} = options;
let timer;
const cancelablePromise = new Promise((resolve, reject) => {
if (typeof milliseconds !== 'number' || Math.sign(milliseconds) !== 1) {
throw new TypeError(`Expected \`milliseconds\` to be a positive number, got \`${milliseconds}\``);
}
2016-10-21 06:42:17 +00:00
2021-04-06 17:38:12 +00:00
if (milliseconds === Number.POSITIVE_INFINITY) {
resolve(promise);
return;
}
if (options.signal) {
const {signal} = options;
if (signal.aborted) {
reject(getAbortedReason(signal));
}
signal.addEventListener('abort', () => {
reject(getAbortedReason(signal));
});
}
2022-07-25 16:24:32 +00:00
timer = customTimers.setTimeout.call(undefined, () => {
if (fallback) {
try {
resolve(fallback());
} catch (error) {
reject(error);
}
return;
2017-11-28 20:05:54 +00:00
}
if (typeof promise.cancel === 'function') {
promise.cancel();
}
2022-08-01 09:21:43 +00:00
if (message === false) {
resolve();
}
const errorMessage = typeof message === 'string' ? message : `Promise timed out after ${milliseconds} milliseconds`;
const timeoutError = message instanceof Error ? message : new TimeoutError(errorMessage);
2016-10-21 06:42:17 +00:00
reject(timeoutError);
}, milliseconds);
(async () => {
try {
resolve(await promise);
} catch (error) {
reject(error);
} finally {
2022-07-25 16:24:32 +00:00
customTimers.clearTimeout.call(undefined, timer);
}
})();
});
cancelablePromise.clear = () => {
2022-07-25 16:24:32 +00:00
customTimers.clearTimeout.call(undefined, timer);
timer = undefined;
};
2016-10-21 06:42:17 +00:00
return cancelablePromise;
2021-04-06 17:38:12 +00:00
}