Minor refactoring and improved docs

Author: ctrlplusb

README.md

@@ -1,8 +1,8 @@
 # zeit-now-node-server
 
-An unofficial package allowing you to create Node Server instances of your Zeit `@now/node` lambdas.
+An unofficial package allowing you to create Node [`http.Server`](https://nodejs.org/api/http.html#http_class_http_server) instances of your [Zeit](https://zeit.co/) [`@now/node`](https://zeit.co/docs/builders#official-builders/node-js) lambdas.
 
-Doing so allows you to write unit/integration tests for your routes.
+Enables you to write unit/integration tests for your lambdas, or to perform manual testing against a local server instance.
 
 [![npm](https://img.shields.io/npm/v/zeit-now-node-server.svg?style=flat-square)](http://npm.im/zeit-now-node-server)
 [![MIT License](https://img.shields.io/npm/l/zeit-now-node-server.svg?style=flat-square)](http://opensource.org/licenses/MIT)
@@ -15,19 +15,67 @@ Doing so allows you to write unit/integration tests for your routes.
 npm install zeit-now-node-server
 ```
 
-### Example Jest Test
+## Supported API
+
+This package has taken the code from the official [`@now/node`](https://zeit.co/docs/builders#official-builders/node-js) builder in order to ensure maximum API compatibility. As far as I am aware we have 100% API coverage.
+
+## Unit testing your lambdas
+
+In the below example we will make use of a local server in order to perform an integration test against our lambda.
+
+We will be making use of the [`test-listen`](https://github.com/zeit/test-listen) package, which accepts a [`http.Server`](https://nodejs.org/api/http.html#http_class_http_server) instance and will return a unique URL based on an available port.
+
+We will also make use of [`axios`](https://github.com/axios/axios) in order to make the request against our lambda.
 
 ```javascript
 import { createServer } from 'zeit-now-node-server';
 import listen from 'test-listen';
 import axios from 'axios';
-import routeUnderTest from './api/hello-world';
+import helloLambda from './api/hello';
+
+let server;
+let url;
+
+beforeAll(() => {
+  server = createServer(routeUnderTest);
+  url = await listen(server);
+});
+
+afterAll(() => {
+  server.close();
+});
 
-it('should allow me to test my node lambdas' async () => {
-  const server = createServer(routeUnderTest);
-  const url = await listen(server);
+it('should return the expected response' async () => {
   const response = await axios.get(url);
   expect(response.data).toBe('Hello world');
-  server.close();
 });
 ```
+
+## Running a local server
+
+Given the following lambda.
+
+```javascript
+const helloLambda = (req, res) => {
+  res.send(`Hello ${req.query.name}`);
+};
+```
+
+You can create a Node [`http.Server`](https://nodejs.org/api/http.html#http_class_http_server) instance like so.
+
+```javascript
+import { createServer } from 'zeit-node-now-server';
+import helloLambda from './api/hello';
+
+const server = createServer(helloLambda);
+
+// start listening on port 8000
+server.listen(8000);
+```
+
+Then you can then make requests against it.
+
+```bash
+> curl http://localhost:8000?name=Pearl
+Hello Pearl%
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zeit-now-node-server",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Create a server for your Zeit @now/node lambdas in order to test them",
   "license": "MIT",
   "author": "Sean Matheson",

src/index.ts

@@ -21,61 +21,55 @@ export class ApiError extends Error {
   }
 }
 
-function getBodyParser(req: IncomingMessage, body: Buffer) {
-  return function parseBody(): NowRequestBody {
-    if (!req.headers['content-type']) {
-      return undefined;
-    }
+function parseBody(req: IncomingMessage, body: Buffer): NowRequestBody {
+  if (!req.headers['content-type']) {
+    return undefined;
+  }
 
-    const { type } = parseContentType(req.headers['content-type']);
+  const { type } = parseContentType(req.headers['content-type']);
 
-    if (type === 'application/json') {
-      try {
-        return JSON.parse(body.toString());
-      } catch (error) {
-        throw new ApiError(400, 'Invalid JSON');
-      }
+  if (type === 'application/json') {
+    try {
+      return JSON.parse(body.toString());
+    } catch (error) {
+      throw new ApiError(400, 'Invalid JSON');
     }
+  }
 
-    if (type === 'application/octet-stream') {
-      return body;
-    }
+  if (type === 'application/octet-stream') {
+    return body;
+  }
 
-    if (type === 'application/x-www-form-urlencoded') {
-      // note: querystring.parse does not produce an iterable object
-      // https://nodejs.org/api/querystring.html#querystring_querystring_parse_str_sep_eq_options
-      return parseQS(body.toString());
-    }
+  if (type === 'application/x-www-form-urlencoded') {
+    // note: querystring.parse does not produce an iterable object
+    // https://nodejs.org/api/querystring.html#querystring_querystring_parse_str_sep_eq_options
+    return parseQS(body.toString());
+  }
 
-    if (type === 'text/plain') {
-      return body.toString();
-    }
+  if (type === 'text/plain') {
+    return body.toString();
+  }
 
-    return undefined;
-  };
+  return undefined;
 }
 
-function getQueryParser({ url = '/' }: IncomingMessage) {
-  return function parseQuery(): NowRequestQuery {
-    // we provide a placeholder base url because we only want searchParams
-    const params = new URL(url, 'https://n').searchParams;
+function parseQuery({ url = '/' }: IncomingMessage): NowRequestQuery {
+  // we provide a placeholder base url because we only want searchParams
+  const params = new URL(url, 'https://n').searchParams;
 
-    const query: { [key: string]: string | string[] } = {};
-    params.forEach((value, name) => {
-      query[name] = value;
-    });
-    return query;
-  };
+  const query: { [key: string]: string | string[] } = {};
+  params.forEach((value, name) => {
+    query[name] = value;
+  });
+  return query;
 }
 
-function getCookieParser(req: IncomingMessage) {
-  return function parseCookie(): NowRequestCookies {
-    const header: undefined | string | string[] = req.headers.cookie;
-    if (!header) {
-      return {};
-    }
-    return parse(Array.isArray(header) ? header.join(';') : header);
-  };
+function parseCookie(req: IncomingMessage): NowRequestCookies {
+  const header: undefined | string | string[] = req.headers.cookie;
+  if (!header) {
+    return {};
+  }
+  return parse(Array.isArray(header) ? header.join(';') : header);
 }
 
 export const createServer = (
@@ -87,9 +81,9 @@ export const createServer = (
       body:
         typeof bufferOrString === 'string'
           ? bufferOrString
-          : getBodyParser(req, bufferOrString)(),
-      cookies: getCookieParser(req)(),
-      query: getQueryParser(req)(),
+          : parseBody(req, bufferOrString),
+      cookies: parseCookie(req),
+      query: parseQuery(req),
     });
     let _status: number;
     const nowRes = Object.assign(res, {