Class APIClient

The APIClient class provides a basic HTTP client for making API requests. It includes methods for making GET, POST, PUT, PATCH, and DELETE requests.

Subclasses should define the baseURL to specify the root URL for all requests.

The class allows for customization of the request and response through the before and after hooks, which can be overridden in subclasses to modify behavior before sending a request or after receiving a response.

Example

class MyAPIClient extends APIClient {
  readonly baseURL = new URL("https://api.example.com/");

  async before(request: Request) {
    const token = await fetchToken();
    request.headers.set('Authorization', `Bearer ${token}`);
    return request;
  }
}

Implements

Type

Index

Constructors

constructor

new APIClient(baseURL: URL, options?: Options): APIClient
Parameters
- baseURL: URL
- options: Options = ...
Returns APIClient
- Defined in index.ts:28

Properties

`Protected` `Readonly`baseURL

baseURL: URL

The base URL for all API requests. Must be defined in subclasses.

interceptors

interceptors: {
after: Interceptor<AfterListenerFunction>;
before: Interceptor<BeforeListenerFunction>;
} = ...

`Protected`options

options: Options

Methods

`Protected`after

after(_request: Request, response: Response): Promise<Response>
This method is called after the response is received. It can be used to process or inspect the response before returning it.
Parameters
- _request: Request
- response: Response
  The response object that was received.
Returns Promise<Response>
A promise that resolves to the (possibly processed) response.
- Defined in index.ts:61

`Protected`before

before(request: Request): Promise<Request>
This method is called before the request is sent. It can be used to modify the request before it is sent (e.g., adding headers).
Parameters
- request: Request
  The request object that will be sent.
Returns Promise<Request>
A promise that resolves to the (possibly modified) request.
- Defined in index.ts:49

delete

delete(path: string, init?: Omit<RequestInit, "method">): Promise<Response>
Sends a DELETE request to the specified path.
Parameters
- path: string
  The path to send the request to, relative to baseURL.
- Optionalinit: Omit<RequestInit, "method">
  Optional request options, excluding the HTTP method.
Returns Promise<Response>
A promise that resolves to the response from the request.
Implementation of Type.delete
- Defined in index.ts:142

fetch

fetch(path: string, init?: RequestInit): Promise<Response>
Sends a fetch request to the specified path, using the provided RequestInit options.
Parameters
- path: string
  The path to send the request to, relative to baseURL.
- Optionalinit: RequestInit
  Optional request options.
Returns Promise<Response>
A promise that resolves to the response from the request.
Implementation of Type.fetch
- Defined in index.ts:73

get

get(path: string, init?: Omit<RequestInit, "method">): Promise<Response>
Sends a GET request to the specified path.
Parameters
- path: string
  The path to send the request to, relative to baseURL.
- Optionalinit: Omit<RequestInit, "method">
  Optional request options, excluding the HTTP method.
Returns Promise<Response>
A promise that resolves to the response from the request.
Implementation of Type.get
- Defined in index.ts:98

patch

patch(path: string, init?: Omit<RequestInit, "method">): Promise<Response>
Sends a PATCH request to the specified path.
Parameters
- path: string
  The path to send the request to, relative to baseURL.
- Optionalinit: Omit<RequestInit, "method">
  Optional request options, excluding the HTTP method.
Returns Promise<Response>
A promise that resolves to the response from the request.
Implementation of Type.patch
- Defined in index.ts:131

post

post(path: string, init?: Omit<RequestInit, "method">): Promise<Response>
Sends a POST request to the specified path.
Parameters
- path: string
  The path to send the request to, relative to baseURL.
- Optionalinit: Omit<RequestInit, "method">
  Optional request options, excluding the HTTP method.
Returns Promise<Response>
A promise that resolves to the response from the request.
Implementation of Type.post
- Defined in index.ts:109

put

put(path: string, init?: Omit<RequestInit, "method">): Promise<Response>
Sends a PUT request to the specified path.
Parameters
- path: string
  The path to send the request to, relative to baseURL.
- Optionalinit: Omit<RequestInit, "method">
  Optional request options, excluding the HTTP method.
Returns Promise<Response>
A promise that resolves to the response from the request.
Implementation of Type.put
- Defined in index.ts:120

Class APIClient

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns APIClient

Properties

Protected ReadonlybaseURL

interceptors

Protectedoptions

Methods

Protectedafter

Parameters

Returns Promise<Response>

Protectedbefore

Parameters

Returns Promise<Request>

delete

Parameters

Returns Promise<Response>

fetch

Parameters

Returns Promise<Response>

get

Parameters

Returns Promise<Response>

patch

Parameters

Returns Promise<Response>

post

Parameters

Returns Promise<Response>

put

Parameters

Returns Promise<Response>

Settings

On This Page

`Protected` `Readonly`baseURL

`Protected`options

`Protected`after

`Protected`before