Http Service

@aleph-alpha/lib-http

This package is used to make HTTP requests. It currently wraps ky, a lightweight HTTP client.

# To install this package
  pnpm add @aleph-alpha/lib-http

Creating an Http Service Instance

To create a new instance of the Http service, you can use the http factory function. This function takes an optional configuration object as a parameter and returns an instance of the Http service.

import { http } from '@aleph-alpha/lib-http';

// Recommended usage
const httpService = http({
  baseURL: 'https://api.example.com',
  timeout: 5000,
});

Setting Bearer Token

After authentication, you can set the Bearer token using the setToken method.

httpService.setToken('token');

Making Requests

You can make HTTP requests using the methods provided by the Http service instance. For example, to make a GET request:

const response = await httpService.get('/todos/1');
console.log(response.data);

Configuration Options

The http factory function accepts an optional configuration object with the following properties:

• baseURL: The base URL for the requests.
• timeout: The timeout in milliseconds for the requests.
• headers: An object of headers to be sent with every request.
• retry: Options for retrying failed requests.
• hooks: Hooks for modifying the request or response.
• body: The request body.
• signal: An AbortSignal to cancel the request.
• params: Query parameters to be sent with every request.
• method: The HTTP method to use.
• onDownloadProgress: A callback for download progress events.
• parseResponseBody: A function to parse the result of the request. If not specified, default is to guess depending on the mime type

Methods

The Http service instance provides the following methods for making HTTP requests:

• head: Makes a HEAD request.
• get: Makes a GET request.
• post: Makes a POST request.
• put: Makes a PUT request.
• delete: Makes a DELETE request.
• patch: Makes a PATCH request.
• setToken: Sets the Bearer token for authentication.
• clearBearerToken: Clears the Bearer token.
• updateConfig: Updates the configuration of the Http service instance.

Each request method returns a Promise that resolves to a Response object, which contains the response data, status, status text, and headers.