All Symbols - web-client documentation

default

A lightweight HTTP client built on fetch with automatic retries, configurable timeouts, and rate-limit handling via Retry-After.

Examples

Fetch JSON with retries and a timeout

import { WebClient } from "@anabranch/web-client";

const client = WebClient.create()
  .withBaseUrl("https://api.example.com")
  .withTimeout(10_000)
  .withRetry({ attempts: 3 });

const user = await client.get("/users/1").map(r => r.data).run();

Classes

HttpError(details: { url: URL; method: string; status?: number; reason: string; isRetryable: boolean; isRateLimited: boolean; retryAfter?: number; })

Error for a failed HTTP request.

name: string

WebClient(config: ResolvedConfig)

An HTTP client built on fetch with automatic retries and error handling.

config: ResolvedConfig
create(): WebClient
Creates a new WebClient with all defaults.
delete(
path: string,
options?: RequestOptions
): Task<ResponseResult, HttpError>
Make a DELETE request.
get(
path: string,
options?: RequestOptions
): Task<ResponseResult, HttpError>
Make a GET request.
patch(
path: string,
body: unknown,
options?: RequestOptions
): Task<ResponseResult, HttpError>
Make a PATCH request with a body.
post(
path: string,
body: unknown,
options?: RequestOptions
): Task<ResponseResult, HttpError>
Make a POST request with a body.
put(
path: string,
body: unknown,
options?: RequestOptions
): Task<ResponseResult, HttpError>
Make a PUT request with a body.
request(
path: string,
method: Method,
options?: RequestOptions,
body?: unknown
): Task<ResponseResult, HttpError>
Make an HTTP request with the specified method.
withBaseUrl(url: string | URL): WebClient
Returns a new WebClient with the given base URL.
withFetch(fetch: globalThis.fetch): WebClient
Returns a new WebClient using the given fetch function.
withHeaders(headers: Record<string, string>): WebClient
Returns a new WebClient with the given headers merged into existing ones.
withRetry(retry: RetryOptions): WebClient
Returns a new WebClient with retry options field-merged into existing ones.
withTimeout(ms: number): WebClient
Returns a new WebClient with the given timeout in milliseconds.

Interfaces

RequestOptions

Options for an individual request, overriding client defaults.

ResponseResult

Successful HTTP response data.

RetryOptions

Configuration for automatic retry behavior.

Type Aliases

Method =

HTTP request methods supported by the WebClient.