Updated docs, latest release (0.8.1)

Author: nuxy

Router.html

@@ -304,7 +304,7 @@ <h4 class="name" id="default"><span class="type-signature"></span>default<span c
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line181">line 181</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line191">line 191</a>
     </li></ul></dd>
 
 
@@ -448,7 +448,7 @@ <h4 class="name" id="delete"><span class="type-signature"></span>delete<span cla
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line288">line 288</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line298">line 298</a>
     </li></ul></dd>
 
 
@@ -618,7 +618,7 @@ <h4 class="name" id="get"><span class="type-signature"></span>get<span class="si
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line208">line 208</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line218">line 218</a>
     </li></ul></dd>
 
 
@@ -950,7 +950,7 @@ <h4 class="name" id="patch"><span class="type-signature"></span>patch<span class
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line268">line 268</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line278">line 278</a>
     </li></ul></dd>
 
 
@@ -1120,7 +1120,7 @@ <h4 class="name" id="post"><span class="type-signature"></span>post<span class="
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line228">line 228</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line238">line 238</a>
     </li></ul></dd>
 
 
@@ -1290,7 +1290,7 @@ <h4 class="name" id="put"><span class="type-signature"></span>put<span class="si
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line248">line 248</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line258">line 258</a>
     </li></ul></dd>
 
 
@@ -1567,7 +1567,7 @@ <h4 class="name" id="setPrefix"><span class="type-signature"></span>setPrefix<sp
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line164">line 164</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line174">line 174</a>
     </li></ul></dd>
 
 
@@ -1709,7 +1709,7 @@ <h4 class="name" id="use"><span class="type-signature"></span>use<span class="si
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line136">line 136</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line146">line 146</a>
     </li></ul></dd>
 
 
@@ -1826,7 +1826,16 @@ <h5>Parameters:</h5>
 <div class="section-examples">
 <h5>Example</h5>
 
-    <pre class="prettyprint"><code>router.use(function(req, res, next) {
+    <pre class="prettyprint"><code>// Include function as middleware.
+const Middleware = require('./path/to/middleware');
+
+router.use(Middleware);
+
+  ..
+
+
+// Run function for every request.
+router.use(function(req, res, next) {
   if (req.method() === 'POST') {
     res.status(405).send();
   } else {
@@ -1836,6 +1845,7 @@ <h5>Example</h5>
 
   ..
 
+// Run function on URI path only.
 router.use('/api/test', function(req, res) {
   res.setHeader('Content-Type', 'text/html');
   res.status(200).send('Hello World');
@@ -1862,7 +1872,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

Router.js.html

@@ -159,6 +159,15 @@ <h1 class="page-title">Router.js</h1>
    *   Route/Middleware function (optional).
    *
    * @example
+   * // Include function as middleware.
+   * const Middleware = require('./path/to/middleware');
+   *
+   * router.use(Middleware);
+   *
+   *   ..
+   *
+   *
+   * // Run function for every request.
    * router.use(function(req, res, next) {
    *   if (req.method() === 'POST') {
    *     res.status(405).send();
@@ -169,6 +178,7 @@ <h1 class="page-title">Router.js</h1>
    *
    *   ..
    *
+   * // Run function on URI path only.
    * router.use('/api/test', function(req, res) {
    *   res.setHeader('Content-Type', 'text/html');
    *   res.status(200).send('Hello World');
@@ -401,7 +411,7 @@ <h1 class="page-title">Router.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

RouterRequest.html

@@ -2284,7 +2284,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

RouterResponse.html

@@ -991,7 +991,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

RouterStack.html

@@ -545,7 +545,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

global.html

@@ -160,7 +160,7 @@ <h4 class="name" id="getRoutes"><span class="type-signature"></span>getRoutes<sp
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line334">line 334</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line344">line 344</a>
     </li></ul></dd>
 
 
@@ -342,7 +342,7 @@ <h4 class="name" id="loadRoutes"><span class="type-signature"></span>loadRoutes<
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line301">line 301</a>
+        <a href="Router.js.html">Router.js</a>, <a href="Router.js.html#line311">line 311</a>
     </li></ul></dd>
 
 
@@ -552,7 +552,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

index.html

@@ -49,7 +49,7 @@
 
     <section class="readme">
         <article><h1>L³ router</h1>
-<p><a href="https://badge.fury.io/js/@lambda-lambda-lambda%2Frouter"><img src="https://badge.fury.io/js/@lambda-lambda-lambda%2Frouter.svg" alt="npm version"></a> <a href="https://www.npmjs.com/package/@lambda-lambda-lambda/router"><img src="https://img.shields.io/npm/dm/@lambda-lambda-lambda/router.svg" alt=""></a> <a href="https://app.travis-ci.com/github/lambda-lambda-lambda/router"><img src="https://api.travis-ci.com/lambda-lambda-lambda/router.svg?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/r/lambda-lambda-lambda/router?branch=master"><img src="https://coveralls.io/repos/lambda-lambda-lambda/router/badge.svg?branch=master" alt="Coverage"></a> <a href="https://packagephobia.com/result?p=@lambda-lambda-lambda/router"><img src="https://packagephobia.com/badge?p=@lambda-lambda-lambda/router" alt="Install size"></a></p>
+<p><a href="https://badge.fury.io/js/@lambda-lambda-lambda%2Frouter"><img src="https://badge.fury.io/js/@lambda-lambda-lambda%2Frouter.svg" alt="npm version"></a> <a href="https://www.npmjs.com/package/@lambda-lambda-lambda/router"><img src="https://img.shields.io/npm/dm/@lambda-lambda-lambda/router.svg" alt=""></a> <a href="https://app.travis-ci.com/github/lambda-lambda-lambda/router"><img src="https://img.shields.io/github/actions/workflow/status/lambda-lambda-lambda/router/.github%2Fworkflows%2Fci.yml" alt="Build Status"></a> <a href="https://coveralls.io/r/lambda-lambda-lambda/router?branch=master"><img src="https://coveralls.io/repos/lambda-lambda-lambda/router/badge.svg?branch=master" alt="Coverage"></a> <a href="https://packagephobia.com/result?p=@lambda-lambda-lambda/router"><img src="https://packagephobia.com/badge?p=@lambda-lambda-lambda/router" alt="Install size"></a></p>
 <p>AWS <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html">CloudFront Lambda@Edge</a> serverless application router.</p>
 <p><img src="https://raw.githubusercontent.com/lambda-lambda-lambda/router/master/package.png" alt="lambda-lambda-lambda"></p>
 <h2>Features</h2>
@@ -114,7 +114,7 @@ <h2>Author</h2>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

module-router_Route.html

@@ -125,7 +125,7 @@ <h1 class="page-title">router/Route</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

module-router_Utils.html

@@ -1823,7 +1823,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

router_Request.js.html

@@ -319,7 +319,7 @@ <h1 class="page-title">router/Request.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Nov 06 2023 13:53:04 GMT-0800 (Pacific Standard Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 11:50:16 GMT-0800 (Pacific Standard Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>