@algolia/requester-fetch

What is @algolia/requester-fetch?

@algolia/requester-fetch is a lightweight HTTP client built on top of the Fetch API. It is designed to be used with Algolia's JavaScript API clients but can be used independently for making HTTP requests in a straightforward manner.

What are @algolia/requester-fetch's main functionalities?

Basic GET Request

This feature allows you to make a basic GET request to a specified URL. The response is returned as a promise, which can be handled using `.then` and `.catch`.

const { createFetchRequester } = require('@algolia/requester-fetch');

const requester = createFetchRequester();

requester({
  method: 'GET',
  url: 'https://jsonplaceholder.typicode.com/posts/1'
}).then(response => {
  console.log(response.content);
}).catch(error => {
  console.error(error);
});

POST Request with JSON Body

This feature allows you to make a POST request with a JSON body. You can specify the request method, URL, data, and headers.

const { createFetchRequester } = require('@algolia/requester-fetch');

const requester = createFetchRequester();

requester({
  method: 'POST',
  url: 'https://jsonplaceholder.typicode.com/posts',
  data: JSON.stringify({
    title: 'foo',
    body: 'bar',
    userId: 1
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8'
  }
}).then(response => {
  console.log(response.content);
}).catch(error => {
  console.error(error);
});

Handling Response Headers

This feature allows you to access and handle response headers from the HTTP response. The headers can be accessed using the `.headers` property of the response object.

const { createFetchRequester } = require('@algolia/requester-fetch');

const requester = createFetchRequester();

requester({
  method: 'GET',
  url: 'https://jsonplaceholder.typicode.com/posts/1'
}).then(response => {
  console.log(response.headers.get('Content-Type'));
}).catch(error => {
  console.error(error);
});

Other packages similar to @algolia/requester-fetch

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides a more feature-rich API compared to @algolia/requester-fetch, including request and response interceptors, automatic JSON data transformation, and support for older browsers.

node-fetch

Node-fetch is a lightweight module that brings `window.fetch` to Node.js. It is similar to @algolia/requester-fetch in that it is built on top of the Fetch API, but it is more focused on providing a polyfill for the Fetch API in Node.js environments.

got

Got is a human-friendly and powerful HTTP request library for Node.js. It offers a more extensive set of features compared to @algolia/requester-fetch, including retry mechanisms, advanced stream support, and hooks for modifying requests and responses.

README

The README file is missing

Changelog

5.6.0

• 1939114e1 chore(deps): dependencies 2024-09-23 (#3790) by @algolia-bot
• db4cf48c5 feat(javascript): add logger-console package from v4 (#3823) by @shortcuts