feat: add ETIMEDOUT error code for timeout error (#64)

Added an error code ETIMEDOUT to easily identify timeout error at caller site. Previously, we need to do checking with e.g. `indexOf('Timed out') >= 0`.
nodeshift · Jun 6, 2017 · 5df9f65 · 5df9f65
1 parent f482485
commit 5df9f65
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/lib/circuit.js b/lib/circuit.js
@@ -280,6 +280,7 @@ class CircuitBreaker extends EventEmitter {
         () => {
           timeoutError = true;
           const error = new Error(`Timed out after ${this.options.timeout}ms`);
+          error.code = 'ETIMEDOUT';
           /**
            * Emitted when the circuit breaker action takes longer than `options.timeout`
            * @event CircuitBreaker#timeout

diff --git a/test/test.js b/test/test.js
@@ -127,13 +127,17 @@ test('Fails when the circuit function fails', (t) => {
 });
 
 test('Fails when the circuit function times out', (t) => {
-  t.plan(1);
+  t.plan(2);
   const expected = 'Timed out after 10ms';
+  const expectedCode = 'ETIMEDOUT';
   const breaker = cb(slowFunction, { timeout: 10 });
 
   breaker.fire()
     .then(t.fail)
-    .catch((e) => t.equals(e.message, expected, 'timeout message received'))
+    .catch((e) => {
+      t.equals(e.message, expected, 'timeout message received');
+      t.equals(e.code, expectedCode, 'ETIMEDOUT');
+    })
     .then(t.end);
 });