Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,11 @@ export default function timeoutSignal(timeout) {
// Allow Node.js processes to exit early if only the timeout is running
timeoutId?.unref?.();

return controller.signal;
const {signal} = controller;

signal[Symbol.dispose] = () => {
clearTimeout(timeoutId);
}

return signal;
}
19 changes: 19 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,25 @@ try {
}
```

With [`using`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using#browser_compatibility) syntax for automatic disposal:

```js
import timeoutSignal from 'timeout-signal';

async function hello() {
using signal = timeoutSignal(5000);

try {
const response = await fetch('https://www.google.com', {signal});
// Handle response
} catch (error) {
if (signal.aborted) {
// Handle abortion
}
}
}
```

## API

### timeoutSignal(timeout)
Expand Down
16 changes: 16 additions & 0 deletions test.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import test from 'ava';
import {setTimeout as delay} from 'node:timers/promises';
import {pEvent} from 'p-event';
import timeSpan from 'time-span';
import timeoutSignal from './index.js';
Expand All @@ -16,3 +17,18 @@ test('main', async t => {
t.true(signal.aborted);
t.true(end() < 500);
});

test('using', async t => {
let isAborted = false;

{
using signal = timeoutSignal(300);
signal.addEventListener('abort', () => {
isAborted = true;
})
await delay(100);
}

await delay(500);
t.false(isAborted);
})
Loading