unjs/ofetch
Ofetch
ofetch is an HTTP client built on the native fetch API that adds automatic JSON serialization, request/response interceptors, configurable retry, and timeout handling. It provides descriptive error objects for non-OK responses and automatically parses response bodies based on their content type.
The client supports creating pre-configured instances with preset base URLs, headers, and default options, enabling consistent configuration across a project. It offers full TypeScript type inference for response data and request payloads, and allows extending request options with custom properties while preserving type safety. Additional capabilities include hooking into the request lifecycle via async interceptors, routing requests through proxy servers using standard environment variables, and consuming Server-Sent Events streams in real time.
The library also provides flexible error handling with parsed response bodies, the ability to access raw Response objects, and support for request body serialization including binary data. ofetch is available as a TypeScript package and can be installed via common JavaScript package managers.
Features
- Fetch API Wrappers - Wraps the native fetch API with additional features like interceptors, retry, and timeout.
- JSON Request Serializers - Automatically stringifies object request bodies as JSON and sets the appropriate Content-Type header.
- Automatic Body Deserializers - Automatically converts response data into JSON or Blob based on Content-Type header.
- Response Body Parsing - Automatically parses HTTP response bodies as JSON, text, or binary based on content type.
- HTTP Request Abstractions - Provides a feature-rich fetch wrapper that adds retries, timeouts, and automatic error handling.
- HTTP Request Customization - Merges custom base URL, query parameters, headers, and timeout into every request.
- Fetch-Based HTTP Clients - Ships a full-featured HTTP client built on the native fetch API with automatic JSON parsing, interceptors, retry, and timeout handling.
- Client Instance Defaults - Creates reusable HTTP client instances with preset base URL, headers, and default options.
- Retry Policies - Provides configurable retry of failed requests with custom status codes and delay between attempts.
- API Request Configurations - Configures base URLs, default headers, and query parameters that apply to every request.
- Pre-Configured HTTP Clients - Offers a factory function to create reusable HTTP clients with preset base URLs, headers, and default options.
- API Request Configurations - Configures base URL, query parameters, and custom headers that apply to each request.
- Descriptive HTTP Error Responses - Throws descriptive errors that include the parsed response body for non-OK HTTP responses.
- HTTP Error Handling - Throws descriptive errors with parsed response body for non-OK statuses.
- Descriptive HTTP Error Responses - Provides descriptive error objects containing the parsed response body for failed HTTP requests.
- HTTP Request Interceptors - Provides async interceptors that hook into the request and response lifecycle for modification and logging.
- Content-Type Based Deserializers - Automatically parses response bodies as JSON, blob, or text based on the Content-Type header.
- Request Body Attachers - Automatically stringifies JSON request bodies and sets Content-Type headers, with binary support.
- Request Lifecycle Hooks - Provides async hooks for logging, authentication, and dynamic modification during request lifecycle.
- Request-Response Interceptors - Enables global interceptors to modify or log outgoing requests and incoming responses.
- Request Retries - Automatically retries failed HTTP requests with configurable status codes, count, and delay.
- Server Error Retries - Retries requests automatically on server error status codes with configurable delay and count.
- Type-Safe Option Extensions - Adds custom properties to request configuration objects while preserving full type safety.
- Request Abort Signals - Supports request timeout and custom cancellation signals to abort ongoing requests.
- Response Type Inference - Infers response data types automatically so editors provide autocomplete for fields.
- Request Timeouts - Aborts requests that exceed a specified time limit to prevent hanging connections.
- Type-Safe API Clients - Provides full TypeScript type inference for response data and request payloads, ensuring type-safe client-server communication.
