Skip to content

fix: use the built-in abortable async setTimeout from node:timers/promises #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2025
Merged

fix: use the built-in abortable async setTimeout from node:timers/promises #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2ed0ef
fix: use the built-in abortable async setTimeout from `node:timers/pr…
zone117x Mar 4, 2025
953afa0
Merge branch 'master' into fix/use-nodejs-sleep-builtin
zone117x Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions src/helpers/time.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { addAbortListener } from 'node:events';
import { setTimeout as setTimeoutAsync } from 'node:timers/promises';

/**
* Wait a set amount of milliseconds or until the timer is aborted.
Expand All @@ -7,19 +7,8 @@ import { addAbortListener } from 'node:events';
* @returns Promise
*/
export function timeout(ms: number, abort?: AbortController | AbortSignal): Promise<void> {
return new Promise((resolve, reject) => {
const signal = abort && 'signal' in abort ? abort.signal : abort;
if (signal?.aborted) return reject(signal.reason);
const disposable = signal ? addAbortListener(signal, onAbort) : undefined;
const timeout = setTimeout(() => {
disposable?.[Symbol.dispose ?? (Symbol.for('nodejs.dispose') as typeof Symbol.dispose)]();
resolve();
}, ms);
function onAbort() {
clearTimeout(timeout);
reject(signal?.reason);
}
});
const signal = abort && (abort instanceof AbortSignal ? abort : abort.signal);
return setTimeoutAsync(ms, undefined, { signal });
}

/**
Expand Down