@oleksii-pavlov/http v1.3.1

HTTPClient Class Documentation

Overview

The HTTPClient class is a flexible and configurable HTTP client designed for making various types of HTTP requests (GET, POST, PUT, PATCH, DELETE, and custom methods) in a standardized manner. It allows users to customize the configuration at both the client level and per-request level. This class supports JSON requests and responses, automatically handling JSON parsing if specified. Additionally, it leverages TypeScript's generics to provide strong typing for response data, ensuring that you receive the expected data shape from your API requests.

Constructor

HTTPClient(config: ClientConfig = {})

• Parameters:

  • config: An optional ClientConfig object that sets the default configuration for the client instance. Reference

• Example:

  const client = new HTTPClient({ base: 'https://api.example.com' })

Methods

get<Result>(path: string, init: RequestOptions = {}, config: ClientConfig = {})

• Description: Sends a GET request to the specified path.

• Parameters:

  • path: The endpoint path (appended to the base URL defined by ClientConfig in constructor).
  • init: Optional RequestOptions to override the default request options. Reference
  • config: Optional ClientConfig to override the client instance's default configuration for this request. Reference

• Returns: A Promise that resolves to a Result, which is the expected response type.

• Generics:

  • Result: The expected type of the response data. This can be any shape depending on your API response.

post<Body, Result>(path: string, body: Body, init: RequestOptions = {}, config: ClientConfig = {})

• Description: Sends a POST request to the specified path with the provided body.

• Parameters:

  • path: The endpoint path.
  • body: The request body, which will be stringified if json is true. Reference
  • init: Optional RequestOptions. Reference
  • config: Optional ClientConfig. Reference

• Returns: A Promise that resolves to a Result, which is the expected response type.

• Generics:

  • Body: The type of the request body.
  • Result: The expected type of the response data.

put<Body, Result>(path: string, body: Body, init: RequestOptions = {}, config: ClientConfig = {})

• Description: Sends a PUT request to the specified path with the provided body.

• Parameters: Same as post().

• Returns: A Promise that resolves to a Result, which is the expected response type.

• Generics:

  • Body: The type of the request body.
  • Result: The expected type of the response data.

patch<Body, Result>(path: string, body: Body, init: RequestOptions = {}, config: ClientConfig = {})

• Description: Sends a PATCH request to the specified path with the provided body.

• Parameters: Same as post().

• Returns: A Promise that resolves to a Result, which is the expected response type.

• Generics:

  • Body: The type of the request body.
  • Result: The expected type of the response data.

delete<Result>(path: string, init: RequestOptions = {}, config: ClientConfig = {})

• Description: Sends a DELETE request to the specified path.

• Parameters:

  • path: The endpoint path.
  • init: Optional RequestOptions. Reference
  • config: Optional ClientConfig. Reference

• Returns: A Promise that resolves to a Result, which is the expected response type.

• Generics:

  • Result: The expected type of the response data.

other<Result>(method: string, path: string, init: RequestInit = {}, config: ClientConfig = {})

• Description: Sends a request with a custom HTTP method.

• Parameters:

  • method: The HTTP method (e.g., HEAD, OPTIONS).
  • path: The endpoint path.
  • init: Optional RequestInit (Fetch API).
  • config: Optional ClientConfig. Reference

• Returns: A Promise that resolves to a Result, which is the expected response type.

• Generics:

  • Result: The expected type of the response data.

Interfaces and Types

ClientConfig

The ClientConfig interface defines the configuration options available for the HTTPClient.

• Properties:
  • base?: string (default: ""): Optional base URL for all requests made with the client.
  • json?: boolean (default: true): If true, the client automatically adds Content-Type: application/json to headers and stringifies request bodies.
  • parse?: boolean (default: true if config.json is true): If true, the client automatically parses JSON responses.
  • headers?: () => HeadersInit (default: () => ({})): preloaded headers getter, can be used for authorization, server special etc.
  • middleware?: (response: Response) => Response (default: res => res): contains custom logic to throw exceptions, log responses and so on

RequestOptions

The RequestOptions type is a simplified version of the RequestInit interface (Fetch API), excluding the method and body properties. It allows you to specify options for a request, such as headers, credentials, and more.

type RequestOptions = Omit<RequestInit, 'method' | 'body'>

Example Usage

const client = new HTTPClient({
  base: 'https://api.example.com',
})

interface User {
  id: number
  name: string
}

interface UserDTO {
  name: string
}

// GET request
client.get<User[]>('/users')
  .then(response => console.log(response))
  .catch(error => console.error(error))

// POST request with a JSON body
client.post<UserDTO, User>('/users', { name: 'John Doe' })
  .then(response => console.log(response))
  .catch(error => console.error(error))