Adding a type guard for AxiosError (#2949)

JasonHK · web-flow · commit f472e5da5fe7 · 2020-11-03T10:01:07.000+02:00
Co-authored-by: Jason Kwok &lt;JasonHK@users.noreply.github.com&gt;
diff --git a/index.d.ts b/index.d.ts
@@ -153,6 +153,7 @@ export interface AxiosStatic extends AxiosInstance {
   isCancel(value: any): boolean;
   all<T>(values: (T | Promise<T>)[]): Promise<T[]>;
   spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
+  isAxiosError(payload: any): payload is AxiosError;
 }
 
 declare const axios: AxiosStatic;
diff --git a/lib/axios.js b/lib/axios.js
@@ -47,6 +47,9 @@ axios.all = function all(promises) {
 };
 axios.spread = require('./helpers/spread');
 
+// Expose isAxiosError
+axios.isAxiosError = require('./helpers/isAxiosError');
+
 module.exports = axios;
 
 // Allow use of default import syntax in TypeScript
diff --git a/lib/helpers/isAxiosError.js b/lib/helpers/isAxiosError.js
@@ -0,0 +1,11 @@
+'use strict';
+
+/**
+ * Determines whether the payload is an error thrown by Axios
+ *
+ * @param {*} payload The value to test
+ * @returns {boolean} True if the payload is an error thrown by Axios, otherwise false
+ */
+module.exports = function isAxiosError(payload) {
+  return (typeof payload === 'object') && (payload.isAxiosError === true);
+};
diff --git a/test/specs/api.spec.js b/test/specs/api.spec.js
@@ -41,6 +41,10 @@ describe('static api', function () {
     expect(typeof axios.CancelToken).toEqual('function');
     expect(typeof axios.isCancel).toEqual('function');
   });
+
+  it('should have isAxiosError properties', function () {
+    expect(typeof axios.isAxiosError).toEqual('function');
+  });
 });
 
 describe('instance api', function () {
diff --git a/test/specs/helpers/isAxiosError.spec.js b/test/specs/helpers/isAxiosError.spec.js
@@ -0,0 +1,20 @@
+var createError = require('../../../lib/core/createError');
+var enhanceError = require('../../../lib/core/enhanceError');
+var isAxiosError = require('../../../lib/helpers/isAxiosError');
+
+describe('helpers::isAxiosError', function () {
+  it('should return true if the error is created by core::createError', function () {
+    expect(isAxiosError(createError('Boom!', { foo: 'bar' })))
+      .toBe(true);
+  });
+
+  it('should return true if the error is enhanced by core::enhanceError', function () {
+    expect(isAxiosError(enhanceError(new Error('Boom!'), { foo: 'bar' })))
+      .toBe(true);
+  });
+
+  it('should return false if the error is a normal Error instance', function () {
+    expect(isAxiosError(new Error('Boom!')))
+      .toBe(false);
+  });
+});
diff --git a/test/specs/instance.spec.js b/test/specs/instance.spec.js
@@ -19,6 +19,7 @@ describe('instance', function () {
         'isCancel',
         'all',
         'spread',
+        'isAxiosError',
         'default'].indexOf(prop) > -1) {
         continue;
       }
diff --git a/test/typescript/axios.ts b/test/typescript/axios.ts
@@ -358,3 +358,12 @@ axios.get('/user', {
 });
 
 source.cancel('Operation has been canceled.');
+
+// AxiosError
+
+axios.get('/user')
+  .catch((error) => {
+    if (axios.isAxiosError(error)) {
+      const axiosError: AxiosError = error;
+    }
+  });

Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,7 @@ export interface AxiosStatic extends AxiosInstance {`
`153`	`153`	`isCancel(value: any): boolean;`
`154`	`154`	`all<T>(values: (T \| Promise<T>)[]): Promise<T[]>;`
`155`	`155`	`spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;`
	`156`	`+ isAxiosError(payload: any): payload is AxiosError;`
`156`	`157`	`}`
`157`	`158`
`158`	`159`	`declare const axios: AxiosStatic;`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ describe('instance', function () {`
`19`	`19`	`'isCancel',`
`20`	`20`	`'all',`
`21`	`21`	`'spread',`
	`22`	`+ 'isAxiosError',`
`22`	`23`	`'default'].indexOf(prop) > -1) {`
`23`	`24`	`continue;`
`24`	`25`	`}`