deno.land / std@0.224.0 / async / deadline.ts

deadline.ts
View Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
import { delay } from "./delay.ts";
/** Options for {@linkcode Deadline}. */export interface DeadlineOptions { /** Signal used to abort the deadline. */ signal?: AbortSignal;}
/** Error thrown when {@linkcode Deadline} times out. */export class DeadlineError extends Error { /** * Constructs a new {@linkcode DeadlineError} instance. * * @example * ```ts * import { DeadlineError } from "https://deno.land/std@$STD_VERSION/async/deadline.ts"; * * throw new DeadlineError(); * ``` */ constructor() { super("Deadline"); this.name = this.constructor.name; }}
/** * Create a promise which will be rejected with {@linkcode DeadlineError} when * a given delay is exceeded. * * Note: Prefer to use {@linkcode AbortSignal.timeout} instead for the APIs * that accept {@linkcode AbortSignal}. * * @example * ```ts * import { deadline } from "https://deno.land/std@$STD_VERSION/async/deadline.ts"; * import { delay } from "https://deno.land/std@$STD_VERSION/async/delay.ts"; * * const delayedPromise = delay(1000); * // Below throws `DeadlineError` after 10 ms * const result = await deadline(delayedPromise, 10); * ``` */export function deadline<T>( p: Promise<T>, ms: number, options: DeadlineOptions = {},): Promise<T> { const controller = new AbortController(); const { signal } = options; if (signal?.aborted) { return Promise.reject(new DeadlineError()); } signal?.addEventListener("abort", () => controller.abort(signal.reason)); const d = delay(ms, { signal: controller.signal }) .catch(() => {}) // Do NOTHING on abort. .then(() => Promise.reject(new DeadlineError())); return Promise.race([p.finally(() => controller.abort()), d]);}
std

Version Info

Tagged at
6 months ago