Refactor config name statuses => errorCodes

Author: flexdinesh

README.md

@@ -59,17 +59,17 @@ _Default_: 0
 
 _Example_: `waitTime: 3000`
 
-#### statuses
+#### errorCodes
 
-Response statuses for which the interceptor should retry.
+Response errorCodes for which the interceptor should retry.
 
 Ideally any implementation should retry only 5xx status(server errors) and should not retry 4xx status(client errors). The reason is, if a http call fails with a client error, then the retry call will have the same headers/params and will obviously fail. So **by default all 5xx errors will be retried**. If you want to customize the status for which the retries should be made, use this config.
 
 _Type_: Array
 
 _Default_: []
 
-_Example_: `[500, 501, 401]`
+_Example_: `errorCodes: [500, 501, 401]`
 
 ## Author's note
 

examples/example.js

@@ -8,7 +8,7 @@ const http = axios.create({
 axiosRetryInterceptor(http, {
   maxAttempts: 3,
   waitTime: 1000, // in milliseconds
-  statuses: [408, 522] // [] for all errors
+  errorCodes: [408, 522] // [] for all errors
 });
 
 // all failed http calls will now be retried 3 times

src/axios-retry-interceptor.js

@@ -4,13 +4,13 @@ import t from 'typy';
 const DEFAULT_OPTIONS = {
   maxAttempts: 3,
   waitTime: 0,
-  statuses: []
+  errorCodes: []
 };
 
 const ALLOWED_RETRY_METHODS = ['get', 'put', 'delete', 'head', 'options'];
 
 const shouldRetry = (error) => {
-  const { method: httpMethod, statuses } = error.config;
+  const { method: httpMethod, errorCodes } = error.config;
   const { maxAttempts, __retryCount: retryCount = 0 } = error.config;
   const { response: { status: statusCode } = {} } = error;
 
@@ -20,8 +20,8 @@ const shouldRetry = (error) => {
   if (ALLOWED_RETRY_METHODS.includes(httpMethod)) shouldRetryForMethod = true;
 
   if (
-    (statuses.length === 0 && statusCode >= 500 && statusCode < 600) ||
-    statuses.includes(statusCode)
+    (errorCodes.length === 0 && statusCode >= 500 && statusCode < 600) ||
+    errorCodes.includes(statusCode)
   ) {
     shouldRetryForStatus = true;
   }
@@ -39,7 +39,7 @@ const axiosRetryInterceptor = (axios, options = {}) => {
       ? options.maxAttempts
       : DEFAULT_OPTIONS.maxAttempts,
     waitTime: t(options.waitTime).isNumber ? options.waitTime : DEFAULT_OPTIONS.waitTime,
-    statuses: t(options.statuses).isArray ? options.statuses : DEFAULT_OPTIONS.statuses
+    errorCodes: t(options.errorCodes).isArray ? options.errorCodes : DEFAULT_OPTIONS.errorCodes
   };
 
   axios.interceptors.request.use(

test/axios-retry-interceptor.js

@@ -166,7 +166,7 @@ describe('Axios Retry Interceptor', () => {
         });
     });
 
-    it('should retry only for {statuses} in config', () => {
+    it('should retry only for {errorCodes} in config', () => {
       nock.cleanAll();
       nock(BASE_URL)
         .persist()
@@ -175,7 +175,7 @@ describe('Axios Retry Interceptor', () => {
 
       options = Object.assign(options, {
         maxAttempts: 3,
-        statuses: [408]
+        errorCodes: [408]
       });
 
       axiosRetryInterceptor(http, options);
@@ -191,10 +191,10 @@ describe('Axios Retry Interceptor', () => {
         });
     });
 
-    it('should not retry for status not in {statuses} config', () => {
+    it('should not retry for status not in {errorCodes} config', () => {
       options = Object.assign(options, {
         maxAttempts: 1,
-        statuses: [505]
+        errorCodes: [505]
       });
 
       axiosRetryInterceptor(http, options);