@digitalbazaar/http-client

http-client

An opinionated, isomorphic HTTP client.

Usage

Import httpClient

import https from 'https';
import {httpClient} from '@digitalbazaar/http-client';

Import and initialize a custom Bearer Token client

import {httpClient} from '@digitalbazaar/http-client';

const httpsAgent = new https.Agent({rejectUnauthorized: false});

const accessToken = '12345';
const headers = {Authorization: `Bearer ${accessToken}`};

const client = httpClient.extend({headers, httpsAgent});

// subsequent http calls will include an 'Authorization: Bearer 12345' header,
// and use the provided httpsAgent

GET a JSON response in the browser

try {
  result = await httpClient.get('http://httpbin.org/json');
  return result.data;
} catch(e) {
  // status is HTTP status code
  // data is JSON error from the server
  const {data, status} = e;
  throw e;
}

GET a JSON response in Node with a HTTP Agent

import https from 'https';
// use an agent to avoid self-signed certificate errors
const agent = new https.Agent({rejectUnauthorized: false});
try {
  result = await httpClient.get('http://httpbin.org/json', {agent});
  return result.data;
} catch(e) {
  // status is HTTP status code
  // data is JSON error from the server if available
  const {data, status} = e;
  throw e;
}

GET HTML by overriding default headers

const headers = {Accept: 'text/html'};
try {
  result = await httpClient.get('http://httpbin.org/json', {headers});
  // see: https://developer.mozilla.org/en-US/docs/Web/API/Body#Methods
  return result.response.text();
} catch(e) {
  // status is HTTP status code
  // any message from the server can be parsed from the response if present
  const {response, status} = e;
  throw e;
}

POST a JSON payload

try {
  result = await httpClient.post('http://httpbin.org/json', {
    // `json` is the payload or body of the POST request
    json: {some: 'data'}
  });
  return result.data;
} catch(e) {
  // status is HTTP status code
  // data is JSON error from the server
  const {data, status} = e;
  throw e;
}

POST a JSON payload in Node with a HTTP Agent

import https from 'https';
// use an agent to avoid self-signed certificate errors
const agent = new https.Agent({rejectUnauthorized: false});
try {
  result = await httpClient.post('http://httpbin.org/json', {
    agent,
    // `json` is the payload or body of the POST request
    json: {some: 'data'}
  });
  return result.data;
} catch(e) {
  // status is HTTP status code
  // data is JSON error from the server
  const {data, status} = e;
  throw e;
}

Changelog

3.0.0 - 2022-04-20

Changed

• BREAKING: Convert to module (ESM) internally and use conditional exports to export a directory that has an entry point for CommonJS.

• Use ky@0.30 and ky-universal@0.10.1.

• BREAKING: Only specific methods and properties are proxied from ky on httpClient instances now. This includes the same set of functions that were proxied in previous versions:

  get, post, put, push, patch, head, delete

  With the same caveat that these functions return a promise that resolves to the response (just like in previous versions, but different from ky which returns the response synchronously). This version also proxies create and extend, where extend now properly inherits options from the parent ky instance. The stop property is also proxied, but returns a promise that resolves to the ky.stop signal. This change was made because the latest version of ky is ESM-only -- and to continue supporting a CJS build, it meant importing the library dynamically. Therefore, the ky instance must settle before it can be used -- requiring all httpClient methods and accessors to be asynchronous.

Removed

• BREAKING: Drop support for node 10 and 12.