Rename serverTimeout to serverUnavailable. Closes #117. (#119)

* Rename serverTiemout to serverUnavailable * Revert TOC changes * Put back tests for serverTimeout
hapijs · Jun 20, 2016 · c082525 · c082525
1 parent 5d67ac0
commit c082525
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -653,14 +653,14 @@ Generates the following response payload:
 }
 ```
 
-### `Boom.serverTimeout([message], [data])`
+### `Boom.serverUnavailable([message], [data])`
 
 Returns a 503 Service Unavailable error where:
 - `message` - optional message.
 - `data` - optional additional error data.
 
 ```js
-Boom.serverTimeout('unavailable');
+Boom.serverUnavailable('unavailable');
 ```
 
 Generates the following response payload:

diff --git a/lib/index.js b/lib/index.js
@@ -375,11 +375,14 @@ exports.badGateway = function (message, data) {
 };
 
 
-exports.serverTimeout = function (message, data) {
+exports.serverUnavailable = function (message, data) {
 
-    return internals.serverError(message, data, 503, exports.serverTimeout);
+    return internals.serverError(message, data, 503, exports.serverUnavailable);
 };
 
+// Deprecated
+exports.serverTimeout = exports.serverUnavailable;
+
 
 exports.gatewayTimeout = function (message, data) {
 

diff --git a/test/index.js b/test/index.js
@@ -526,7 +526,6 @@ describe('illegal()', () => {
     });
 });
 
-
 describe('serverTimeout()', () => {
 
     it('returns a 503 error statusCode', (done) => {
@@ -542,6 +541,21 @@ describe('serverTimeout()', () => {
     });
 });
 
+describe('serverUnavailable()', () => {
+
+    it('returns a 503 error statusCode', (done) => {
+
+        expect(Boom.serverUnavailable().output.statusCode).to.equal(503);
+        done();
+    });
+
+    it('sets the message with the passed in message', (done) => {
+
+        expect(Boom.serverUnavailable('my message').message).to.equal('my message');
+        done();
+    });
+});
+
 describe('forbidden()', () => {
 
     it('returns a 403 error statusCode', (done) => {
@@ -678,8 +692,8 @@ describe('stack trace', () => {
             'badData', 'preconditionRequired', 'tooManyRequests',
 
             // 500s
-            'internal', 'notImplemented', 'badGateway', 'serverTimeout', 'gatewayTimeout',
-            'badImplementation'
+            'internal', 'notImplemented', 'badGateway', 'serverTimeout', 'serverUnavailable',
+            'gatewayTimeout', 'badImplementation'
         ].forEach((name) => {
 
             const err = Boom[name]();