fvtt-types/src/foundry/common/utils/http.d.mts

TypeScript type definitions for Foundry VTT

import type { InexactPartial } from "#utils";

/**
 * A wrapper method around `fetch` that attaches an AbortController signal to the `fetch` call for clean timeouts
 * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal#aborting_a_fetch_with_timeout_or_explicit_abort}
 * @param url     - The URL to make the Request to
 * @param data    - The data of the Request (default: `{}`)
 * @param options - Additional Options (default: `{}`)
 * @throws HttpError
 */
export declare function fetchWithTimeout(url: string, data?: RequestInit, options?: TimeoutOptions): Promise<Response>;

/**
 * A small wrapper that automatically asks for JSON with a Timeout
 * @param url     - The URL to make the Request to
 * @param data    - The data of the Request (default: `{}`)
 * @param options - Additional options (default: `{}`)
 */
export declare function fetchJsonWithTimeout(
  url: string,
  data?: RequestInit,
  options?: TimeoutOptions,
): Promise<unknown>;

/** @internal */
type _TimeoutOptions = InexactPartial<{
  /**
   * How long to wait for a Response before cleanly aborting. If null, no timeout is applied
   * @defaultValue `30000`
   */
  timeoutMs: number | null;

  /**
   * A method to invoke if and when the timeout is reached
   * @defaultValue `() => {}`
   */
  onTimeout: () => void;
}>;

interface TimeoutOptions extends _TimeoutOptions {}

/**
 * Test whether a file source exists by performing a HEAD request against it
 * @param src - The source URL or path to test
 * @returns Does the file exist at the provided url?
 */
export function srcExists(src: string): Promise<boolean>;

/**
 * Represents an HTTP Error when a non-OK response is returned by Fetch
 */
export declare class HttpError extends Error {
  constructor(statusText: string, code: number, displayMessage?: string);

  code: number;

  displayMessage: string;

  override toString(): string;
}