doc/index.html at master · lambda-lambda-lambda/doc · GitHub

1
2
3
4
<!DOCTYPE html><htmllang="en" style="font-size:16px"><head><metacharset="utf-8"><metaname="viewport" content="width=device-width,initial-scale=1"><title>Home</title><!--[if lt IE 9]>
 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
 <![endif]--><scriptsrc="scripts/third-party/hljs.js" defer="defer"></script><scriptsrc="scripts/third-party/hljs-line-num.js" defer="defer"></script><scriptsrc="scripts/third-party/popper.js" defer="defer"></script><scriptsrc="scripts/third-party/tippy.js" defer="defer"></script><scriptsrc="scripts/third-party/tocbot.min.js"></script><script>varbaseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><linkrel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svgaria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbolid="copy-icon" viewbox="0 0 488.3 488.3"><g><pathd="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><pathd="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbolid="search-icon" viewBox="0 0 512 512"><g><g><pathd="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><pathd="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbolid="font-size-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbolid="add-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbolid="minus-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M5 11h14v2H5z"/></symbol><symbolid="dark-theme-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbolid="light-theme-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbolid="reset-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbolid="down-icon" viewBox="0 0 16 16"><pathfill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbolid="codepen-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbolid="close-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbolid="menu-icon" viewBox="0 0 24 24"><pathfill="none" d="M0 0h24v24H0z"/><pathd="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><bodydata-theme="dark"><divclass="sidebar-container"><divclass="sidebar" id="sidebar"><divclass="sidebar-items-container"><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="module-router_Route.html">router/Route</a></div><divclass="sidebar-section-children"><ahref="module-router_Utils.html">router/Utils</a></div></div><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="Router.html">Router</a></div><divclass="sidebar-section-children"><ahref="RouterRequest.html">RouterRequest</a></div><divclass="sidebar-section-children"><ahref="RouterResponse.html">RouterResponse</a></div><divclass="sidebar-section-children"><ahref="RouterStack.html">RouterStack</a></div></div><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="global.html#getRoutes">getRoutes</a></div><divclass="sidebar-section-children"><ahref="global.html#loadRoutes">loadRoutes</a></div></div></div></div></div><divclass="navbar-container" id="VuAckcnZhf"><navclass="navbar"><divclass="navbar-left-items"></div><divclass="navbar-right-items"><divclass="navbar-right-item"><buttonclass="icon-button search-button" aria-label="open-search"><svg><usexlink:href="#search-icon"></use></svg></button></div><divclass="navbar-right-item"><buttonclass="icon-button theme-toggle" aria-label="toggle-theme"><svg><useclass="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><divclass="navbar-right-item"><buttonclass="icon-button font-size" aria-label="change-font-size"><svg><usexlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><divclass="toc-container"><divclass="toc-content"><spanclass="bold">On this page</span><divid="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><divclass="body-wrapper"><divclass="main-content"><divclass="main-wrapper"><sectionclass="readme"><article><h1id="l%C2%B3-router">L³ router</h1><p><ahref="https://badge.fury.io/js/@lambda-lambda-lambda%2Frouter"><imgsrc="https://badge.fury.io/js/@lambda-lambda-lambda%2Frouter.svg" alt="npm version"></a><ahref="https://www.npmjs.com/package/@lambda-lambda-lambda/router"><imgsrc="https://img.shields.io/npm/dm/@lambda-lambda-lambda/router.svg" alt=""></a><ahref="https://github.com/lambda-lambda-lambda/router/actions"><imgsrc="https://img.shields.io/github/actions/workflow/status/lambda-lambda-lambda/router/.github%2Fworkflows%2Fci.yml" alt="Build Status"></a><ahref="https://coveralls.io/r/lambda-lambda-lambda/router?branch=master"><imgsrc="https://coveralls.io/repos/lambda-lambda-lambda/router/badge.svg?branch=master" alt="Coverage"></a><ahref="https://packagephobia.com/result?p=@lambda-lambda-lambda/router"><imgsrc="https://packagephobia.com/badge?p=@lambda-lambda-lambda/router" alt="Install size"></a><ahref="https://github.com/nuxy/no-ai-badge"><imgsrc="https://raw.githubusercontent.com/nuxy/no-ai-badge/master/badge.svg" alt="NO AI"></a></p><p>AWS <ahref="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 id="features">Features</h2><ul><li>Request/Response handling <a href="https://github.com/lambda-lambda-lambda/manual/blob/master/CommonMethods.md">API</a>.</li><li><a href="https://github.com/lambda-lambda-lambda/manual/blob/master/ComplexRouting.md#route-handler">Routes</a> and URI <a href="https://github.com/lambda-lambda-lambda/manual/blob/master/ComplexRouting.md#resource-handler">Resource</a> support.</li><li>Local/Globally scoped <a href="https://github.com/lambda-lambda-lambda/manual/blob/master/Middleware.md#scope">Middleware</a>.</li><li><a href="https://code.visualstudio.com">Visual Studio Code</a> integration.</li><li>Open Source, <a href="https://github.com/lambda-lambda-lambda/router/blob/master/LICENSE">MIT licensed</a>, FREE.</li><li>Lightweight (<strong>no dependencies</strong>).</li></ul><h2 id="how-does-it-work%3F">How does it work?</h2><p>In its most basic form the library provides helper methods that translate the <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html">CloudFront Lambda@Edge</a> <code>origin-request</code> allowing you to handle response processing <strong>without the need to construct complex Lambda dependent responses</strong>.</p><p>To better visualize how L³ fits in the current AWS ecosystem the following high-level graph describes the <em>HTTP Request/Response lifecycle</em> and role of each AWS provided service.</p><p><img src="https://raw.githubusercontent.com/lambda-lambda-lambda/manual/master/images/Request-Response-Lifecycle.png" alt="HTTP Request/Response lifecycle"></p><h2 id="getting-started">Getting started</h2><p>The easiest way to created an application, without the need to <a href="#manual-installation">manually install</a> this package, is to use the <a href="https://marketplace.visualstudio.com/items?itemName=Nuxy.vscode-lambda-lambda-lambda">L³ Visual Studio Code extension</a>. Doing so allows you to..</p><ul><li>Scaffold app sources and dependencies.</li><li>Run it locally (in <a href="https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers">Remote - Containers</a>)</li><li>Test code changes in realtime.</li><li>Deploy app sources to AWS.</li><li>Generate <a href="https://jsdoc.app">JSDoc</a>/<a href="https://swagger.io">Swagger</a> documentation.</li></ul><h2 id="build-dependencies">Build dependencies</h2><p>If you're not using the <a href="https://marketplace.visualstudio.com/items?itemName=Nuxy.vscode-lambda-lambda-lambda">L³ VS Code extension</a> and want to <em>run this package locally</em> you must install the following dependencies:</p><ul><li><a href="https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html">AWS SAM CLI</a></li><li><a href="https://nodejs.org">Node.js</a></li></ul><h2 id="manual-installation">Manual installation</h2><p>If you just looking to leverage the Request/Response handling <a href="CommonMethods.md">API</a> in your Lambda functions, install this package using <a href="https://npmjs.com">NPM</a>.</p><pre><code>$ npm install @lambda-lambda-lambda/router
</code></pre><h2id="documentation">Documentation</h2><ul><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/Introduction.md">Introduction</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/GettingStarted.md">Getting Started</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/AWSRequirements.md">AWS requirements</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/RunningYourApp.md">Running your App</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/Usage.md">Usage</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/CommonMethods.md">Common methods</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/ComplexRouting.md">Complex routing</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/Middleware.md">Middleware</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/Developers.md">Developers</a></li><li><ahref="https://github.com/lambda-lambda-lambda/manual/blob/master/Testing.md">Testing</a></li></ul><h2id="aws-changes-starting-in-node.js-24-(cloudwatch-warning)">AWS changes starting in Node.js 24 (CloudWatch warning)</h2><p>Going forward, it is recommended that you build your L³ application using <code>async</code> handlers in anticipation of the AWS changes below.</p><blockquote><p>AWS Lambda plans to remove support for callback-based function handlers starting with Node.js 24. You will need to update this function to use an async handler to use Node.js 24 or later. For more information and to provide feedback on this change, see aws/aws-lambda-nodejs-runtime-interface-client#137</p></blockquote><p>While backwards compatibity will be supported for older Node.js releases this support <strong>will eventually be phased out</strong> with the deprecation of <code>nodejs22.x</code> (Apr 30, 2027).</p><p>See <ahref="https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported">AWS Node.js Supported Runtimes</a> for support information.</p><h2id="versioning">Versioning</h2><p>This package is maintained under the <ahref="https://semver.org">Semantic Versioning</a> guidelines.</p><h2id="license-and-warranty">License and Warranty</h2><p>This package is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.</p><p><em>lambda-lambda-lambda/router</em> is provided under the terms of the <ahref="http://www.opensource.org/licenses/mit-license.php">MIT license</a></p><p><ahref="https://aws.amazon.com">AWS</a> is a registered trademark of Amazon Web Services, Inc.</p><h2id="author">Author</h2><p><ahref="https://github.com/nuxy">Marc S. Brooks</a></p></article></section></div></div></div><divclass="search-container" id="PkfLWpAbet" style="display:none"><divclass="wrapper" id="iCxFxjkHbP"><buttonclass="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><usexlink:href="#close-icon"></use></svg></button><divclass="search-box-c"><svg><usexlink:href="#search-icon"></use></svg><inputtype="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><divclass="search-result-c" id="fWwVHRuDuN"><spanclass="search-result-c-text">Type anything to view search result</span></div></div></div><divclass="mobile-menu-icon-container"><buttonclass="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><usexlink:href="#menu-icon"></use></svg></button></div><divid="mobile-sidebar" class="mobile-sidebar-container"><divclass="mobile-sidebar-wrapper"><divclass="mobile-nav-links"></div><divclass="mobile-sidebar-items-c"><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="module-router_Route.html">router/Route</a></div><divclass="sidebar-section-children"><ahref="module-router_Utils.html">router/Utils</a></div></div><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="Router.html">Router</a></div><divclass="sidebar-section-children"><ahref="RouterRequest.html">RouterRequest</a></div><divclass="sidebar-section-children"><ahref="RouterResponse.html">RouterResponse</a></div><divclass="sidebar-section-children"><ahref="RouterStack.html">RouterStack</a></div></div><divclass="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><usexlink:href="#down-icon"></use></svg></div><divclass="sidebar-section-children-container"><divclass="sidebar-section-children"><ahref="global.html#getRoutes">getRoutes</a></div><divclass="sidebar-section-children"><ahref="global.html#loadRoutes">loadRoutes</a></div></div></div><divclass="mobile-navbar-actions"><divclass="navbar-right-item"><buttonclass="icon-button search-button" aria-label="open-search"><svg><usexlink:href="#search-icon"></use></svg></button></div><divclass="navbar-right-item"><buttonclass="icon-button theme-toggle" aria-label="toggle-theme"><svg><useclass="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><divclass="navbar-right-item"><buttonclass="icon-button font-size" aria-label="change-font-size"><svg><usexlink:href="#font-size-icon"></use></svg></button></div></div></div></div><scripttype="text/javascript" src="scripts/core.min.js"></script><scriptsrc="scripts/search.min.js" defer="defer"></script><scriptsrc="scripts/third-party/fuse.js" defer="defer"></script><scripttype="text/javascript">vartocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>