Skip to content

Commit 1e157db

Browse files
committed
Updated docs, latest release (0.7.1)
1 parent e7d8c6d commit 1e157db

14 files changed

Lines changed: 29 additions & 29 deletions

Router.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1862,7 +1862,7 @@ <h5>Example</h5>
18621862
<br class="clear">
18631863

18641864
<footer>
1865-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
1865+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
18661866
</footer>
18671867

18681868
<script>prettyPrint();</script>

Router.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ <h1 class="page-title">Router.js</h1>
4040
<section>
4141
<article>
4242
<pre class="prettyprint source linenums"><code>/**
43-
* lambda-lambda-lambda
43+
* lambda-lambda-lambda/router
4444
* AWS Lambda@Edge serverless application router.
4545
*
4646
* Copyright 2021-2023, Marc S. Brooks (https://mbrooks.info)
@@ -398,7 +398,7 @@ <h1 class="page-title">Router.js</h1>
398398
<br class="clear">
399399

400400
<footer>
401-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
401+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
402402
</footer>
403403

404404
<script>prettyPrint();</script>

RouterRequest.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2284,7 +2284,7 @@ <h5>Returns:</h5>
22842284
<br class="clear">
22852285

22862286
<footer>
2287-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
2287+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
22882288
</footer>
22892289

22902290
<script>prettyPrint();</script>

RouterResponse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -991,7 +991,7 @@ <h5>Returns:</h5>
991991
<br class="clear">
992992

993993
<footer>
994-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
994+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
995995
</footer>
996996

997997
<script>prettyPrint();</script>

RouterStack.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ <h5>Example</h5>
545545
<br class="clear">
546546

547547
<footer>
548-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
548+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
549549
</footer>
550550

551551
<script>prettyPrint();</script>

global.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ <h5>Example</h5>
552552
<br class="clear">
553553

554554
<footer>
555-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
555+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
556556
</footer>
557557

558558
<script>prettyPrint();</script>

index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@
4848

4949

5050
<section class="readme">
51-
<article><h1>lambda-lambda-lambda</h1>
52-
<p><a href="https://badge.fury.io/js/lambda-lambda-lambda"><img src="https://badge.fury.io/js/lambda-lambda-lambda.svg" alt="npm version"></a> <a href="https://www.npmjs.com/package/lambda-lambda-lambda"><img src="https://img.shields.io/npm/dm/lambda-lambda-lambda.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></p>
51+
<article><h1>L³ router</h1>
52+
<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></p>
5353
<p>AWS <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html">CloudFront Lambda@Edge</a> serverless application router.</p>
54-
<p><img src="https://raw.githubusercontent.com/nuxy/lambda-lambda-lambda/master/package.png" alt="lambda-lambda-lambda"></p>
54+
<p><img src="https://raw.githubusercontent.com/lambda-lambda-lambda/router/master/package.png" alt="lambda-lambda-lambda"></p>
5555
<h2>Features</h2>
5656
<ul>
5757
<li><a href="#route-handler">Routes</a> and URI <a href="#resource-handler">Resource</a> support.</li>
@@ -76,7 +76,7 @@ <h2>Getting started</h2>
7676
</ul>
7777
<h3>Manual installation</h3>
7878
<p>Install package dependencies using <a href="https://npmjs.com">NPM</a>.</p>
79-
<pre><code>$ npm install lambda-lambda-lambda
79+
<pre><code>$ npm install @lambda-lambda-lambda/router
8080
</code></pre>
8181
<h2>Usage</h2>
8282
<p>Unless your application requires <a href="#complex-routing">complex routing</a>, route handlers can be defined within the <a href="https://docs.aws.amazon.com/lambda/latest/operatorguide/global-scope.html">Lambda function scope</a>. Otherwise <a href="#route-handler">route handlers</a> are loaded from <code>appName/src/routes</code> directory in hierarchical order, starting with the default handler <code>appName/src/app.js</code> as described below.</p>
@@ -86,7 +86,7 @@ <h3>Synchronous example</h3>
8686
'use strict';
8787

8888
// Load module.
89-
const Router = require('lambda-lambda-lambda');
89+
const Router = require('@lambda-lambda-lambda/router');
9090

9191
/**
9292
* @see AWS::Serverless::Function
@@ -125,7 +125,7 @@ <h3>Asynchronous example</h3>
125125
'use strict';
126126

127127
// Load module.
128-
const Router = require('lambda-lambda-lambda');
128+
const Router = require('@lambda-lambda-lambda/router');
129129

130130
/**
131131
* @see AWS::Serverless::Function
@@ -141,7 +141,7 @@ <h3>Asynchronous example</h3>
141141
};
142142
</code></pre>
143143
<h2>Common methods</h2>
144-
<p>The following methods are supported based on the class context. For further information please refer to the <a href="#cli-options">JSDoc</a> generated <a href="https://nuxy.github.io/lambda-lambda-lambda">documentation</a> which includes method <code>arguments</code>/<code>return</code> types and general usage examples.</p>
144+
<p>The following methods are supported based on the class context. For further information please refer to the <a href="#cli-options">JSDoc</a> generated <a href="https://lambda-lambda-lambda.github.io/doc">documentation</a> which includes method <code>arguments</code>/<code>return</code> types and general usage examples.</p>
145145
<table>
146146
<thead>
147147
<tr>
@@ -498,7 +498,7 @@ <h3>Asynchronous example</h3>
498498
</code></pre>
499499
<p>See <a href="https://github.com/lambda-lambda-lambda/example/tree/master/restfulApiHandler/src/middleware">restfulApiHandler</a> example for more complex use cases.</p>
500500
<h2>Testing</h2>
501-
<p>How you handle this is entirely up to the test framework/runner you're using. For examples using <a href="https://mochajs.org/">Mocha</a> and <a href="https://www.chaijs.com">Chai</a>, please refer to the <a href="https://github.com/nuxy/lambda-lambda-lambda/tree/master/test/e2e/async">E2E tests</a> included with this package.</p>
501+
<p>How you handle this is entirely up to the test framework/runner you're using. For examples using <a href="https://mochajs.org/">Mocha</a> and <a href="https://www.chaijs.com">Chai</a>, please refer to the <a href="https://github.com/lambda-lambda-lambda/router/tree/master/test/e2e/async">E2E tests</a> included with this package.</p>
502502
<h2>AWS requirements</h2>
503503
<p>In order to successfully deploy your application you must have <a href="https://docs.aws.amazon.com/config/latest/developerguide/gs-cli.html">set-up your AWS Config</a> and have <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html">created an IAM user</a> with the following <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html">policies</a>:</p>
504504
<ul>
@@ -548,7 +548,7 @@ <h2>Author</h2>
548548
<br class="clear">
549549

550550
<footer>
551-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
551+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
552552
</footer>
553553

554554
<script>prettyPrint();</script>

module-router_Common.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1617,7 +1617,7 @@ <h5>Example</h5>
16171617
<br class="clear">
16181618

16191619
<footer>
1620-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
1620+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
16211621
</footer>
16221622

16231623
<script>prettyPrint();</script>

module-router_Route.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ <h5>Example</h5>
191191
<br class="clear">
192192

193193
<footer>
194-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
194+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
195195
</footer>
196196

197197
<script>prettyPrint();</script>

router_Common.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ <h1 class="page-title">router/Common.js</h1>
4242
<pre class="prettyprint source linenums"><code>/** @module router/Common */
4343

4444
/**
45-
* lambda-lambda-lambda
45+
* lambda-lambda-lambda/router
4646
* AWS Lambda@Edge serverless application router.
4747
*
4848
* Copyright 2021-2023, Marc S. Brooks (https://mbrooks.info)
@@ -246,7 +246,7 @@ <h1 class="page-title">router/Common.js</h1>
246246
<br class="clear">
247247

248248
<footer>
249-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Apr 08 2023 19:50:15 GMT-0700 (Pacific Daylight Time) using the Minami theme.
249+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Wed Apr 19 2023 12:24:38 GMT-0700 (Pacific Daylight Time) using the Minami theme.
250250
</footer>
251251

252252
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)