123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
// 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]);}