axios-fetch-adapter

An Axios adapter that uses native fetch or a custom fetch function. Useful for Cloudflare Workers and ServiceWorker environments.

Note: This adapter was designed for version 0.21.1 of Axios, which is still used in prominent e-commerce SDKs.

Install

1npm install @haverstack/axios-fetch-adapter

Use

The default use-case for this library is:

1import axios from "axios";
2import fetchAdapter from "@haverstack/axios-fetch-adapter";
3
4const client = axios.create({
5  adapter: fetchAdapter
6});

Using with custom fetch functions

If your application does not use a globally-available fetch, you can specify your own custom fetch function instead:

1import axios from "axios";
2import { createFetchAdapter } from "@haverstack/axios-fetch-adapter";
3import myCustomFetch from "my-custom-fetch";
4
5const myCustomFetchAdapter = createFetchAdapter({ fetch: myCustomFetch });
6const client = axios.create({
7  adapter: myCustomFetchAdapter
8});

If your application allows for using non-fully-qualified URLs, e.g. /foo, use the disableRequest option to pass URLs directly to your custom fetch function without creating a Request object:

1import axios from "axios";
2import { createFetchAdapter } from "@haverstack/axios-fetch-adapter";
3import myCustomFetch from "my-custom-fetch";
4
5const customAdapter = createFetchAdapter({
6  fetch: myCustomFetch,
7  disableRequest: true
8});
9const client = axios.create({
10  adapter: myCustomFetchAdapter
11});

Note: A side effect of the disableRequest option is that the AxiosResponse object will only have the request URL in its request property instead of a Request object. This means that accessing, for example, response.request.url will throw an error.

Using with the Square Node.js SDK

To use this library with the square package to manage your Square resources:

1import { Client, Environment } from "square";
2import fetchAdapter from "@haverstack/axios-fetch-adapter";
3
4const client = new Client({
5  accessToken,
6  environment,
7  unstable_httpClientOptions: { adapter: fetchAdapter }
8});

Development

1# Run tests
2npm run test
3
4# Check tests, linting, and formatting
5npm run check
6
7# Fix linting and formatting
8npm run fix

A Miniflare testing environment is used in order to simulate a Cloudflare Worker or a ServiceWorker. This testing environment is also useful because Node does not have a native implementation of fetch.

Acknowledgements

The code in this repo draws heavily from the following projects:

• vespaiach/axios-fetch-adapter: Most of the initial code in this repo was copied from here. Licensed MIT.
• axios/axios: The buildFullPath function from axios has been copied here and modified to be more flexible. Licensed MIT.

License

MIT