Interface ClientOptions

Options for an example HTTP client.

The source of this page, with its @default tags:

// tsdoc-defaults: import os from 'node:os'
export interface ClientOptions {
  /**
   * Request timeout in milliseconds.
   * @default `10_000`
   */
  timeoutMs?: number;

  /**
   * Retries after a failed request.
   * @defaultValue 3
   */
  retries?: number;

  /**
   * Directory for cached responses.
   * @default `os.tmpdir()`
   */
  cacheDir?: string;

  /**
   * Base URL for relative request paths. Prose stays a "Default" block.
   * @default the origin of the current page
   */
  baseUrl?: string;
}
Copy

The file tsdoc-defaults generates from those tags:

// Generated by tsdoc-defaults from the @default/@defaultValue tags in ./options.ts. Do not edit.
import type { ClientOptions } from './options.js';
import os from 'node:os';

export const DEFAULTS: {
  ClientOptions: Required<
    Pick<ClientOptions, 'timeoutMs' | 'retries' | 'cacheDir'>
  >;
} = {
  ClientOptions: {
    timeoutMs: 10_000,
    retries: 3,
    cacheDir: os.tmpdir(),
  },
};
Copy