Merge pull request hapijs#2451 from arb/proxy-doc-update

Eran Hammer · Eran Hammer · commit 545f940afbd5 · 2015-03-09T12:21:32.000-07:00
Fixed Markdown issue.
diff --git a/API.md b/API.md
@@ -519,7 +519,7 @@ server.route({
     method: 'GET',
     path: '/',
     handler: function (request, reply) {
-    
+
         return reply(request.auth.credentials.user);
     }
 });
@@ -627,7 +627,7 @@ server.route({
     config: {
         auth: 'default',
         handler: function (request, reply) {
-    
+
             return reply(request.auth.credentials.user);
         }
     }
@@ -659,7 +659,7 @@ server.route({
     method: 'GET',
     path: '/',
     handler: function (request, reply) {
-    
+
         request.server.auth.test('default', request, function (err, credentials) {
 
             if (err) {
@@ -753,7 +753,7 @@ Adds an incoming server connection where:
 - `address` - sets the host name or IP address the connection will listen on. If not configured,
   defaults to `host` if present, otherwise to all available network interfaces (i.e. `'0.0.0.0'`).
   Set to `127.0.0.1` or `localhost` to restrict connection to only those coming from the same
-  machine. 
+  machine.
 - `port` - the TCP port the connection will listen to. Defaults to an ephemeral port (`0`) which
   uses an available port when the server is started (and assigned to `server.info.port`). If `port`
   is a string containing a '/' character, it is used as a UNIX domain socket path and if it starts
@@ -1448,7 +1448,7 @@ across multiple requests. Registers a cookie definitions where:
         - `'base64'` - string value is encoded using Base64.
         - `'base64json'` - object value is JSON-stringified than encoded using Base64.
         - `'form'` - object value is encoded using the _x-www-form-urlencoded_ method.
-        - `'iron'` - Encrypts and sign the value using 
+        - `'iron'` - Encrypts and sign the value using
           [**iron**](https://github.com/hueniverse/iron).
     - `sign` - an object used to calculate an HMAC for cookie integrity validation. This does not
       provide privacy, only a mean to verify that the cookie value was generated by the server.
@@ -2527,18 +2527,18 @@ config to an object containing one of these keys:
               value is the header content.
     - `onResponse` - a custom function for processing the response from the upstream service
       before sending to the client. Useful for custom error handling of responses from the
-      proxied endpoint or other payload manipulation. Function signature is 
+      proxied endpoint or other payload manipulation. Function signature is
       `function(err, res, request, reply, settings, ttl)` where:
-          - `err` - internal or upstream error returned from attempting to contact the upstream
-            proxy.
-          - `res` - the node response object received from the upstream service. `res` is a
-            readable stream (use the [**wreck**](https://github.com/hapijs/wreck) module `read`
-            method to easily convert it to a Buffer or string).
-          - `request` - is the incoming [request object](#request-object).
-          - `reply` - the [reply interface](#reply-interface) function.
-          - `settings` - the proxy handler configuration.
-          - `ttl` - the upstream TTL in milliseconds if `proxy.ttl` it set to `'upstream'` and
-            the upstream response included a valid 'Cache-Control' header with 'max-age'.
+      - `err` - internal or upstream error returned from attempting to contact the upstream
+        proxy.
+      - `res` - the node response object received from the upstream service. `res` is a
+        readable stream (use the [**wreck**](https://github.com/hapijs/wreck) module `read`
+        method to easily convert it to a Buffer or string).
+      - `request` - is the incoming [request object](#request-object).
+      - `reply` - the [reply interface](#reply-interface) function.
+      - `settings` - the proxy handler configuration.
+      - `ttl` - the upstream TTL in milliseconds if `proxy.ttl` it set to `'upstream'` and
+        the upstream response included a valid 'Cache-Control' header with 'max-age'.
     - `ttl` - if set to `'upstream'`, applies the upstream response caching policy to the
       response using the `response.ttl()` method (or passed as an argument to the `onResponse`
       method if provided).
@@ -2911,7 +2911,7 @@ where:
 - `result` - an optional response payload.
 
 Since an request can only have one response regardless if it is an error or success, the `reply()`
-method can only result in a single response value. This means that passing both an `err` and 
+method can only result in a single response value. This means that passing both an `err` and
 `result` will only use the `err`. There is no requirement for either `err` or `result` to be (or
 not) an `Error` object. The framework will simply use the first argument if present, otherwise the
 second. The method supports two arguments to be compatible with the common callback pattern of
