woodland 18.2.4 → 18.2.6

package/LICENSE

@@ -1,27 +1,27 @@
-Copyright (c) 2023, Jason Mulligan
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of woodland nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (c) 2024, Jason Mulligan
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of woodland nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,251 +1,251 @@
-<img src="https://avoidwork.github.io/woodland/logo.svg" width="108" />
-
-# Woodland
-
-Lightweight HTTP framework with automatic headers. Routes can use parameter syntax, i.e. `/users/:id`, or `RegExp` syntax. Route parameters are not sanitized. If 2+ routes with parameters match a request the first route will be used to extract parameters. All HTTP methods are supported.
-
-`CORS` (Cross Origin Resource Sharing) is automatically handled, and indicated with `cors` Boolean on the `request` Object for middleware.
-
-Middleware arguments can be `req, res, next` or `error, req, res, next`. If no `Error` handling middleware is registered woodland will handle it.
-
-## Using the factory
-
-```javascript
-import {createServer} from "node:http";
-import {woodland} from "woodland";
-
-const app = woodland({
-  defaultHeaders: {
-    "cache-control": "public, max-age=3600",
-    "content-type": "text/plain"
-  },
-  time: true
-});
-
-app.get("/", (req, res) => res.send("Custom greeting at '/:user', try it out!"));
-app.get("/:user", (req, res) => res.send(`Hello ${req.params.user}!`));
-createServer(app.route).listen(8000);
-```
-
-## Using the Class
-
-```javascript
-import {Woodland} from "woodland";
-class MyFramework extends Woodland {};
-```
-
-## Testing
-
-Woodland has 100% code coverage with its tests; the missing 0.22% is hard to reach conditions.
-
-```console
---------------|---------|----------|---------|---------|-------------------------------
-File          | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
---------------|---------|----------|---------|---------|-------------------------------
-All files     |   99.78 |    76.02 |   98.57 |     100 | 
- woodland.cjs |   99.78 |    76.02 |   98.57 |     100 | ...214,254,275-285,314-328,...
---------------|---------|----------|---------|---------|-------------------------------
-```
-
-## Benchmark
-Please benchmark `woodland` on your target hardware to understand the overhead which is expected to be <15% with etags disabled, or <25% with etags enabled. E.g. if `http` can handle 50k req/s, then `woodland` should handle 43k req/s.
-
-1. Clone repository from [GitHub](https://github.com/avoidwork/woodland).
-1. Install dependencies with `npm` or `yarn`.
-1. Execute `benchmark` script with `npm` or `yarn`.
-
-Results with node.js 20.8.0 & an Intel i9-12900HX (mobile) on Windows 11, with etags disabled.
-
-```console
-> node benchmark.js
-
-http
-┌─────────┬──────┬──────┬───────┬───────┬──────────┬──────────┬───────┐
-│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max   │
-├─────────┼──────┼──────┼───────┼───────┼──────────┼──────────┼───────┤
-│ Latency │ 1 ms │ 8 ms │ 42 ms │ 47 ms │ 10.81 ms │ 10.26 ms │ 88 ms │
-└─────────┴──────┴──────┴───────┴───────┴──────────┴──────────┴───────┘
-┌───────────┬─────────┬─────────┬───────┬───────┬─────────┬─────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%   │ 97.5% │ Avg     │ Stdev   │ Min     │
-├───────────┼─────────┼─────────┼───────┼───────┼─────────┼─────────┼─────────┤
-│ Req/Sec   │ 75967   │ 75967   │ 88703 │ 93823 │ 88409.6 │ 4152.76 │ 75952   │
-├───────────┼─────────┼─────────┼───────┼───────┼─────────┼─────────┼─────────┤
-│ Bytes/Sec │ 15.4 MB │ 15.4 MB │ 18 MB │ 19 MB │ 17.9 MB │ 841 kB  │ 15.4 MB │
-└───────────┴─────────┴─────────┴───────┴───────┴─────────┴─────────┴─────────┘
-
-woodland
-┌─────────┬──────┬──────┬───────┬───────┬──────────┬──────────┬────────┐
-│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max    │
-├─────────┼──────┼──────┼───────┼───────┼──────────┼──────────┼────────┤
-│ Latency │ 2 ms │ 9 ms │ 57 ms │ 67 ms │ 12.82 ms │ 13.04 ms │ 119 ms │
-└─────────┴──────┴──────┴───────┴───────┴──────────┴──────────┴────────┘
-┌───────────┬─────────┬─────────┬─────────┬─────────┬──────────┬─────────┬─────────┐
-│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg      │ Stdev   │ Min     │
-├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
-│ Req/Sec   │ 66687   │ 66687   │ 75263   │ 76095   │ 75041.61 │ 1482.92 │ 66667   │
-├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
-│ Bytes/Sec │ 14.1 MB │ 14.1 MB │ 15.9 MB │ 16.1 MB │ 15.8 MB  │ 312 kB  │ 14.1 MB │
-└───────────┴─────────┴─────────┴─────────┴─────────┴──────────┴─────────┴─────────┘
-
-```
-
-## API
-### constructor ({...})
-Returns a woodland instance. Enable directory browsing & traversal with `autoindex`. Create an automatic `x-response-time` response header with `time` & `digit`. Customize `etag` response header with `seed`.
-
-#### Configuration
-
-```json
-{
-  "autoindex": false,
-  "cacheSize": 1000,
-  "cacheTTL": 300000,
-  "charset": "utf-8",
-  "corsExpose": "",
-  "defaultHeaders": {},
-  "digit": 3,
-  "etags": true,
-  "indexes": [
-    "index.htm",
-    "index.html"
-  ],
-  "logging": {
-    "enabled": true,
-    "format": "%h %l %u %t \"%r\" %>s %b",
-    "level": "info"
-  },
-  "origins": [
-    "*"
-  ],
-  "silent": false,
-  "time": false
-}
-```
-
-### allowed (method, uri, override = false)
-Calls `routes()` and returns a `Boolean` to indicate if `method` is allowed for `uri`.
-
-### allows (uri, override = false)
-Returns a `String` for the `Allow` header. Caches value, & will update cache if `override` is `true`.
-
-### always (path, fn)
-Registers middleware for a route for all HTTP methods; runs first. `path` is a regular expression (as a string), and if not passed it defaults to `/.*`.
-
-Execute `ignore(fn)` if you do not want the middleware included for calculating the `Allow` header.
-
-### ignore (fn)
-Ignores `fn` for calculating the return of `allows()`.
-
-### decorate (req, res)
-Decorates `allow, body, cors, host, ip, params, & parsed` on `req` and `error(status[, body, headers]), header(key, value), json(body[, status, headers]), locals{} & redirect(url[, perm = false])` on `res`.
-
-### etag (...args)
-Returns a String to be used as an etag response header value.
-
-### list (method = "get", type = "array")
-Returns an `Array` or `Object` of routes for the specified method.
-
-### log (msg = "", level = "debug")
-Logs to `stdout` or `stderr` depending on the `level`, & what the minimum log level is set to.
-
-### onsend (req, res, body, status, headers)
-**Override** to customize response `body`, `status`, or `headers`. Must return `[body, status, headers]`!
-
-### route (req, res)
-Function for `http.createServer()` or `https.createServer()`.
-
-### routes (uri, method, override = false)
-Returns an `Array` of middleware for the request. Caches value, & will update cache if `override` is `true`.
-
-### serve (req, res, localFilePath, folderPath, indexes = this.indexes)
-Serve static files on disk. Use a route parameter or remove `folderPath` from `req.parsed.pathname` to create `localFilePath`.
-
-#### Without `autoindex`
-```javascript
-app.use("/files/:file", (req, res) => app.serve(req, res, req.params.file, path.join(__dirname, "files")));
-```
-
-#### With `autoindex`
-```javascript
-app.use("/files(/.*)?", (req, res) => app.serve(req, res, req.parsed.pathname.replace(/^\/files\/?/, ""), join(__dirname, "files")));
-```
-
-### staticFiles (root = "/")
-Serve static files on disk. Calls `this.serve()`.
-
-### use ([path = "/.*",] ...fn[, method = "GET"])
-Registers middleware for a route. `path` is a regular expression (as a string), and if not passed it defaults to `/.*`. See `always()` if you want the middleware to be used for all HTTP methods.
-
-All HTTP methods are available on the prototype (partial application of the third argument), e.g. `get([path,] ...fn)` & `options([path,] ...fn)`.
-
-## Command Line Interface (CLI)
-When woodland is installed as a global module you can serve the contents of a folder by executing `woodland` in a shell. Optional parameters are `--ip=127.0.0.1` & `--port=8000`.
-
-```console
-Node.js v20.8.0
-PS C:\Users\jason\Projects> npm install -g woodland
-
-changed 6 packages in 1s
-PS C:\Users\jason\Projects> woodland
-id=woodland, hostname=localhost, ip=127.0.0.1, port=8000
-127.0.0.1 -  [7/Oct/2023:15:18:18 -0400] "GET / HTTP/1.1" 200 1327
-127.0.0.1 -  [7/Oct/2023:15:18:26 -0400] "GET /woodland/ HTTP/1.1" 200 2167
-127.0.0.1 -  [7/Oct/2023:15:18:29 -0400] "GET /woodland/dist/ HTTP/1.1" 200 913
-127.0.0.1 -  [7/Oct/2023:15:18:32 -0400] "GET /woodland/dist/woodland.js HTTP/1.1" 200 26385
-127.0.0.1 -  [7/Oct/2023:15:18:47 -0400] "GET /woodland/benchmark.js HTTP/1.1" 200 1657
-127.0.0.1 -  [7/Oct/2023:15:18:58 -0400] "GET /woodland/sample.js HTTP/1.1" 200 845
-127.0.0.1 -  [7/Oct/2023:15:19:07 -0400] "GET /woodland/sample.js HTTP/1.1" 304 0
-```
-
-## Event Handlers
-Event Emitter syntax for the following events:
-
-```javascript
-app.on("connect", (req, res) => res.header("x-custom-header", "abc-def"));
-```
-
-### connect (req, res)
-Executes after the connection has been decorated, but before the middleware executes.
-
-### error (req, res, err)
-Executes after the response has been sent.
-
-### finish (req, res)
-Executes after the response has been sent.
-
-## Helpers
-`req` & `res` are decorated with helper functions to simplify responding.
-
-### res.error(status[, body, headers])
-Sends an error response.
-
-### res.header(key, value)
-Shorthand of `res.setHeader()`.
-
-### res.json(body, [status = 200, headers])
-Sends a JSON response.
-
-### res.last(req, res, next)
-Last middleware of the route for the HTTP method as a way to "skip" to the middleware which sends a response.
-
-### res.redirect(uri[, perm = false])
-Sends a redirection response.
-
-### res.send(body, [status = 200, headers = {}])
-Sends a response. `Range` header is ignored on `stream` responses.
-
-### res.set(headers = {})
-Shorthand of `res.setHeaders()` which accepts `Object`, `Map`, or `Headers` instances.
-
-### res.status(arg)
-Sets the response `statusCode` property.
-
-## Logging
-Woodland defaults to [Common Log Format](https://en.wikipedia.org/wiki/Common_Log_Format) but supports [Common Log Format with Virtual Host](https://httpd.apache.org/docs/trunk/mod/mod_log_config.html), & [NCSA extended/combined log format](https://httpd.apache.org/docs/trunk/mod/mod_log_config.html) with an `info` level by default. You can change the `stdout` output by changing `logging.format` with valid placeholders.
-
-You can disable woodland's logging by configuration with `{logging: {enabled: false}}`.
-
-## License
-Copyright (c) 2023 Jason Mulligan
-
-Licensed under the BSD-3 license.
+<img src="https://avoidwork.github.io/woodland/logo.svg" width="108" />
+
+# Woodland
+
+Lightweight HTTP framework with automatic headers. Routes can use parameter syntax, i.e. `/users/:id`, or `RegExp` syntax. Route parameters are not sanitized. If 2+ routes with parameters match a request the first route will be used to extract parameters. All HTTP methods are supported.
+
+`CORS` (Cross Origin Resource Sharing) is automatically handled, and indicated with `cors` Boolean on the `request` Object for middleware.
+
+Middleware arguments can be `req, res, next` or `error, req, res, next`. If no `Error` handling middleware is registered woodland will handle it.
+
+## Using the factory
+
+```javascript
+import {createServer} from "node:http";
+import {woodland} from "woodland";
+
+const app = woodland({
+  defaultHeaders: {
+    "cache-control": "public, max-age=3600",
+    "content-type": "text/plain"
+  },
+  time: true
+});
+
+app.get("/", (req, res) => res.send("Custom greeting at '/:user', try it out!"));
+app.get("/:user", (req, res) => res.send(`Hello ${req.params.user}!`));
+createServer(app.route).listen(8000);
+```
+
+## Using the Class
+
+```javascript
+import {Woodland} from "woodland";
+class MyFramework extends Woodland {};
+```
+
+## Testing
+
+Woodland has 100% code coverage with its tests; the missing 0.22% is hard to reach conditions.
+
+```console
+--------------|---------|----------|---------|---------|-------------------------------
+File          | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
+--------------|---------|----------|---------|---------|-------------------------------
+All files     |   99.78 |    76.02 |   98.57 |     100 | 
+ woodland.cjs |   99.78 |    76.02 |   98.57 |     100 | ...214,254,275-285,314-328,...
+--------------|---------|----------|---------|---------|-------------------------------
+```
+
+## Benchmark
+Please benchmark `woodland` on your target hardware to understand the overhead which is expected to be <15% with etags disabled, or <25% with etags enabled. E.g. if `http` can handle 50k req/s, then `woodland` should handle 43k req/s.
+
+1. Clone repository from [GitHub](https://github.com/avoidwork/woodland).
+1. Install dependencies with `npm` or `yarn`.
+1. Execute `benchmark` script with `npm` or `yarn`.
+
+Results with node.js 20.8.0 & an Intel i9-12900HX (mobile) on Windows 11, with etags disabled.
+
+```console
+> node benchmark.js
+
+http
+┌─────────┬──────┬──────┬───────┬───────┬──────────┬──────────┬───────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max   │
+├─────────┼──────┼──────┼───────┼───────┼──────────┼──────────┼───────┤
+│ Latency │ 1 ms │ 8 ms │ 42 ms │ 47 ms │ 10.81 ms │ 10.26 ms │ 88 ms │
+└─────────┴──────┴──────┴───────┴───────┴──────────┴──────────┴───────┘
+┌───────────┬─────────┬─────────┬───────┬───────┬─────────┬─────────┬─────────┐
+│ Stat      │ 1%      │ 2.5%    │ 50%   │ 97.5% │ Avg     │ Stdev   │ Min     │
+├───────────┼─────────┼─────────┼───────┼───────┼─────────┼─────────┼─────────┤
+│ Req/Sec   │ 75967   │ 75967   │ 88703 │ 93823 │ 88409.6 │ 4152.76 │ 75952   │
+├───────────┼─────────┼─────────┼───────┼───────┼─────────┼─────────┼─────────┤
+│ Bytes/Sec │ 15.4 MB │ 15.4 MB │ 18 MB │ 19 MB │ 17.9 MB │ 841 kB  │ 15.4 MB │
+└───────────┴─────────┴─────────┴───────┴───────┴─────────┴─────────┴─────────┘
+
+woodland
+┌─────────┬──────┬──────┬───────┬───────┬──────────┬──────────┬────────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max    │
+├─────────┼──────┼──────┼───────┼───────┼──────────┼──────────┼────────┤
+│ Latency │ 2 ms │ 9 ms │ 57 ms │ 67 ms │ 12.82 ms │ 13.04 ms │ 119 ms │
+└─────────┴──────┴──────┴───────┴───────┴──────────┴──────────┴────────┘
+┌───────────┬─────────┬─────────┬─────────┬─────────┬──────────┬─────────┬─────────┐
+│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg      │ Stdev   │ Min     │
+├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
+│ Req/Sec   │ 66687   │ 66687   │ 75263   │ 76095   │ 75041.61 │ 1482.92 │ 66667   │
+├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
+│ Bytes/Sec │ 14.1 MB │ 14.1 MB │ 15.9 MB │ 16.1 MB │ 15.8 MB  │ 312 kB  │ 14.1 MB │
+└───────────┴─────────┴─────────┴─────────┴─────────┴──────────┴─────────┴─────────┘
+
+```
+
+## API
+### constructor ({...})
+Returns a woodland instance. Enable directory browsing & traversal with `autoindex`. Create an automatic `x-response-time` response header with `time` & `digit`. Customize `etag` response header with `seed`.
+
+#### Configuration
+
+```json
+{
+  "autoindex": false,
+  "cacheSize": 1000,
+  "cacheTTL": 300000,
+  "charset": "utf-8",
+  "corsExpose": "",
+  "defaultHeaders": {},
+  "digit": 3,
+  "etags": true,
+  "indexes": [
+    "index.htm",
+    "index.html"
+  ],
+  "logging": {
+    "enabled": true,
+    "format": "%h %l %u %t \"%r\" %>s %b",
+    "level": "info"
+  },
+  "origins": [
+    "*"
+  ],
+  "silent": false,
+  "time": false
+}
+```
+
+### allowed (method, uri, override = false)
+Calls `routes()` and returns a `Boolean` to indicate if `method` is allowed for `uri`.
+
+### allows (uri, override = false)
+Returns a `String` for the `Allow` header. Caches value, & will update cache if `override` is `true`.
+
+### always (path, fn)
+Registers middleware for a route for all HTTP methods; runs first. `path` is a regular expression (as a string), and if not passed it defaults to `/.*`.
+
+Execute `ignore(fn)` if you do not want the middleware included for calculating the `Allow` header.
+
+### ignore (fn)
+Ignores `fn` for calculating the return of `allows()`.
+
+### decorate (req, res)
+Decorates `allow, body, cors, host, ip, params, & parsed` on `req` and `error(status[, body, headers]), header(key, value), json(body[, status, headers]), locals{} & redirect(url[, perm = false])` on `res`.
+
+### etag (...args)
+Returns a String to be used as an etag response header value.
+
+### list (method = "get", type = "array")
+Returns an `Array` or `Object` of routes for the specified method.
+
+### log (msg = "", level = "debug")
+Logs to `stdout` or `stderr` depending on the `level`, & what the minimum log level is set to.
+
+### onsend (req, res, body, status, headers)
+**Override** to customize response `body`, `status`, or `headers`. Must return `[body, status, headers]`!
+
+### route (req, res)
+Function for `http.createServer()` or `https.createServer()`.
+
+### routes (uri, method, override = false)
+Returns an `Array` of middleware for the request. Caches value, & will update cache if `override` is `true`.
+
+### serve (req, res, localFilePath, folderPath, indexes = this.indexes)
+Serve static files on disk. Use a route parameter or remove `folderPath` from `req.parsed.pathname` to create `localFilePath`.
+
+#### Without `autoindex`
+```javascript
+app.use("/files/:file", (req, res) => app.serve(req, res, req.params.file, path.join(__dirname, "files")));
+```
+
+#### With `autoindex`
+```javascript
+app.use("/files(/.*)?", (req, res) => app.serve(req, res, req.parsed.pathname.replace(/^\/files\/?/, ""), join(__dirname, "files")));
+```
+
+### staticFiles (root = "/")
+Serve static files on disk. Calls `this.serve()`.
+
+### use ([path = "/.*",] ...fn[, method = "GET"])
+Registers middleware for a route. `path` is a regular expression (as a string), and if not passed it defaults to `/.*`. See `always()` if you want the middleware to be used for all HTTP methods.
+
+All HTTP methods are available on the prototype (partial application of the third argument), e.g. `get([path,] ...fn)` & `options([path,] ...fn)`.
+
+## Command Line Interface (CLI)
+When woodland is installed as a global module you can serve the contents of a folder by executing `woodland` in a shell. Optional parameters are `--ip=127.0.0.1` & `--port=8000`.
+
+```console
+Node.js v20.8.0
+PS C:\Users\jason\Projects> npm install -g woodland
+
+changed 6 packages in 1s
+PS C:\Users\jason\Projects> woodland
+id=woodland, hostname=localhost, ip=127.0.0.1, port=8000
+127.0.0.1 -  [7/Oct/2023:15:18:18 -0400] "GET / HTTP/1.1" 200 1327
+127.0.0.1 -  [7/Oct/2023:15:18:26 -0400] "GET /woodland/ HTTP/1.1" 200 2167
+127.0.0.1 -  [7/Oct/2023:15:18:29 -0400] "GET /woodland/dist/ HTTP/1.1" 200 913
+127.0.0.1 -  [7/Oct/2023:15:18:32 -0400] "GET /woodland/dist/woodland.js HTTP/1.1" 200 26385
+127.0.0.1 -  [7/Oct/2023:15:18:47 -0400] "GET /woodland/benchmark.js HTTP/1.1" 200 1657
+127.0.0.1 -  [7/Oct/2023:15:18:58 -0400] "GET /woodland/sample.js HTTP/1.1" 200 845
+127.0.0.1 -  [7/Oct/2023:15:19:07 -0400] "GET /woodland/sample.js HTTP/1.1" 304 0
+```
+
+## Event Handlers
+Event Emitter syntax for the following events:
+
+```javascript
+app.on("connect", (req, res) => res.header("x-custom-header", "abc-def"));
+```
+
+### connect (req, res)
+Executes after the connection has been decorated, but before the middleware executes.
+
+### error (req, res, err)
+Executes after the response has been sent.
+
+### finish (req, res)
+Executes after the response has been sent.
+
+## Helpers
+`req` & `res` are decorated with helper functions to simplify responding.
+
+### res.error(status[, body, headers])
+Sends an error response.
+
+### res.header(key, value)
+Shorthand of `res.setHeader()`.
+
+### res.json(body, [status = 200, headers])
+Sends a JSON response.
+
+### res.last(req, res, next)
+Last middleware of the route for the HTTP method as a way to "skip" to the middleware which sends a response.
+
+### res.redirect(uri[, perm = false])
+Sends a redirection response.
+
+### res.send(body, [status = 200, headers = {}])
+Sends a response. `Range` header is ignored on `stream` responses.
+
+### res.set(headers = {})
+Shorthand of `res.setHeaders()` which accepts `Object`, `Map`, or `Headers` instances.
+
+### res.status(arg)
+Sets the response `statusCode` property.
+
+## Logging
+Woodland defaults to [Common Log Format](https://en.wikipedia.org/wiki/Common_Log_Format) but supports [Common Log Format with Virtual Host](https://httpd.apache.org/docs/trunk/mod/mod_log_config.html), & [NCSA extended/combined log format](https://httpd.apache.org/docs/trunk/mod/mod_log_config.html) with an `info` level by default. You can change the `stdout` output by changing `logging.format` with valid placeholders.
+
+You can disable woodland's logging by configuration with `{logging: {enabled: false}}`.
+
+## License
+Copyright (c) 2024 Jason Mulligan
+
+Licensed under the BSD-3 license.