Skip to main content

axios-http-builder: An Axios instance builder

Image
By

axios-http-builder is an Axios instance builder for use on client or server side with common features pre-configured:

- Timeout
- Cancellation

By default, Axios does not configure a timeout or a cancellation timeout. However, axios-http-builder sets both to 2 seconds by default, which remains configurable.

axios-http-builder also includes an optional exception handler.

Install

npm i -save axios-http-builder 

Usage

To use the default configuration, instantiate the Axios instance with buildHttpClient and then use as normal:

import { buildHttpClient } from 'axios-http-builder';

const httpClient = buildHttpClient();
await httpClient.get('https://myservice/entity');

buildHttpClient takes a CreateAxiosDefaults object, so you can use any of Axios' options as normal:

import { buildHttpClient } from 'axios-http-builder';

const httpClient = buildHttpClient({ baseURL: 'https://myservice' });
await httpClient.get('/entity');

The axios-http-builder defaults are applied to the configuration, unless you specify your own:

import { buildHttpClient, newAbortSignal } from 'axios-http-builder';

const httpClient = buildHttpClient({ baseURL: 'https://myservice' , timeout: 3000, signal: newAbortSignal(3000)});
await httpClient.get('/entity');

The timeout and cancellation timeout can also be set using environment variables:

AXIOS_TIMEOUT=3000
AXIOS_CANCEL_TIMEOUT=3000

Exception Handling

axios-http-builder includes an optional exception handling function:

import { buildHttpClient, handleException } from 'axios-http-builder';

const httpClient = buildHttpClient({ baseURL: 'https://myservice' });
try {
    await httpClient.get('/entity');
} catch (e: any) {
    const { isAxiosError, message, axiosError, data, statusCode, statusText } = handleException(e);
    ...
}

handleException analyses the exception to determine whether it is an AxiosError, Error or something else. It always returns isAxiosError and message. The other values are only returned if the exception is an AxiosError. The intention is to provide a boilerplate function which handles AxiosError and other exceptions and always return the right exception message.

  • isAxiosError - whether or not the exception is an AxiosError
  • message - the exception message
  • axiosError - the AxiosError object. Although this is the same as the original exception, the type of the original exception is not recognised by the compiler, as it could be Error or something else. Only returned for AxiosErrors
  • data - the body of the response. Only returned for AxiosErrors
  • statusCode - the http status code. Only returned for AxiosErrors
  • statusText - the http status text. Only returned for AxiosErrors

Repo: https://github.com/pjgrenyer/axios-http-builder
NPM: https://www.npmjs.com/package/axios-http-builder

Comments

Post a Comment

Popular posts from this blog

Catalina-Ant for Tomcat 7

By
I recently upgraded from Tomcat 6 to Tomcat 7 and all of my Ant deployment scripts stopped working. I eventually worked out why and made the necessary changes, but there doesn’t seem to be a complete description of how to use Catalina-Ant for Tomcat 7 on the web so I thought I'd write one. To start with, make sure Tomcat manager is configured for use by Catalina-Ant. Make sure that manager-script is included in the roles for one of the users in TOMCAT_HOME/conf/tomcat-users.xml . For example: <tomcat-users> <user name="admin" password="s3cr£t" roles="manager-gui, manager-script "/> </tomcat-users> Catalina-Ant for Tomcat 6 was encapsulated within a single JAR file. Catalina-Ant for Tomcat 7 requires four JAR files. One from TOMCAT_HOME/bin : tomcat-juli.jar and three from TOMCAT_HOME/lib: catalina-ant.jar tomcat-coyote.jar tomcat-util.jar There are at least three ways of making the JARs available to Ant: Copy the JARs into th...
22 comments
Read more

Write Your Own Load Balancer: A worked Example

By
I was out walking with a techie friend of mine I’d not seen for a while and he asked me if I’d written anything recently. I hadn’t, other than an article on data sharing a few months before and I realised I was missing it. Well, not the writing itself, but the end result. In the last few weeks, another friend of mine, John Cricket , has been setting weekly code challenges via linkedin and his new website, https://codingchallenges.fyi/ . They were all quite interesting, but one in particular on writing load balancers appealed, so I thought I’d kill two birds with one stone and write up a worked example. You’ll find my worked example below. The challenge itself is italics and voice is that of John Crickets. The Coding Challenge https://codingchallenges.fyi/challenges/challenge-load-balancer/ Write Your Own Load Balancer This challenge is to build your own application layer load balancer. A load balancer sits in front of a group of servers and routes client requests across all of the serv...
Post a Comment
Read more

AWS Summit London 2025

By
It felt good to be back at the AWS Summit . I got a lot out of last year and this year was interesting too. I attended some sessions on interesting topics and some which reassured me I’m doing the right things.  It was good to catch up with some old friends, see my colleagues in person and chat with some of our suppliers at their stands. For an event which boasts 24,000 attendees, most things run extremely smoothly. My only real gripes are not being able to get into some sessions as they were full and the length of time it takes to get a cuppa! Keynote I skipped the keynote last year as I was keen to get on with some hands on labs. This year I thought I’d find out what it was all about. It took place in the 4000 capacity auditorium, but that was full, so I watched in one of the many smaller theatres.  The theatres aren’t exactly small, each one holds more people than the entire nor(DEV):con conference in Norwich. Each is separated by only a curtain and headphones are provided...
Post a Comment
Read more