Handle timeoutErrorMessage if provided

ctimmerm · Feb 27, 2020 · 262c224 · 262c224
1 parent 8215717
commit 262c224
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/src/index.js b/src/index.js
@@ -137,7 +137,7 @@ VERBS.concat('any').forEach(function(method) {
       timeout: function() {
         return reply(function(config) {
           var error = utils.createAxiosError(
-            'timeout of ' + config.timeout + 'ms exceeded',
+            config.timeoutErrorMessage || ('timeout of ' + config.timeout + 'ms exceeded'),
             config,
             undefined,
             'ECONNABORTED'
@@ -149,7 +149,7 @@ VERBS.concat('any').forEach(function(method) {
       timeoutOnce: function() {
         return replyOnce(function(config) {
           var error = utils.createAxiosError(
-            'timeout of ' + config.timeout + 'ms exceeded',
+            config.timeoutErrorMessage || ('timeout of ' + config.timeout + 'ms exceeded'),
             config,
             undefined,
             'ECONNABORTED'

diff --git a/test/timeout.spec.js b/test/timeout.spec.js
@@ -47,4 +47,23 @@ describe('timeout spec', function() {
         expect(response.status).to.equal(200);
       });
   });
+
+  it('responds with timeoutErrorMessage', function() {
+    mock.onGet('/foo').timeout();
+    var timeoutErrorMessage = 'That request sure did time out';
+
+    return instance.get('/foo', {
+      timeoutErrorMessage: timeoutErrorMessage
+    }).then(
+      function() {
+        expect.fail('should not be called');
+      },
+      function(error) {
+        expect(error.config).to.exist;
+        expect(error.code).to.equal('ECONNABORTED');
+        expect(error.message).to.equal(timeoutErrorMessage);
+        expect(error.isAxiosError).to.be.true;
+      }
+    );
+  });
 });