@nikovirtala/projen-constructs 0.3.79 → 0.3.81

package/docs/api/interfaces/LambdaFunctionConstructGeneratorOptions.html

@@ -10,6 +10,9 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">LambdaFunctionConstructGeneratorOptions</a></li></ul>
 <h1>Interface LambdaFunctionConstructGeneratorOptions</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Options for the LambdaFunctionConstructGenerator</p>
+</div></section>
 <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LambdaFunctionConstructGeneratorOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#adddependencies">addDependencies</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#baseconstructclass">baseConstructClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#baseconstructimport">baseConstructImport</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#baseconstructpackage">baseConstructPackage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#esbuildoptions">esbuildOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildOptions</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#filepattern">filePattern</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#outputdir">outputDir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#sourcedir">sourceDir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
@@ -32,28 +35,107 @@
 <section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="adddependencies"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>add<wbr/>Dependencies</span><a href="#adddependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">addDependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">addDependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
+<div class="tsd-comment tsd-typography"><p>Whether to automatically add the required dependencies</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="baseconstructclass"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>base<wbr/>Construct<wbr/>Class</span><a href="#baseconstructclass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">baseConstructClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">baseConstructClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Name of the construct class to extend</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-example">
+<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;NodejsFunction&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div>
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;aws_lambda.Function&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="baseconstructimport"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>base<wbr/>Construct<wbr/>Import</span><a href="#baseconstructimport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">baseConstructImport</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">baseConstructImport</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Import statement for the base construct</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-example">
+<h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;import { NodejsFunction } from &#39;aws-cdk-lib/aws-lambda-nodejs&#39;;&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div>
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;import { aws_lambda } from &#39;aws-cdk-lib&#39;;&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="baseconstructpackage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>base<wbr/>Construct<wbr/>Package</span><a href="#baseconstructpackage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">baseConstructPackage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">baseConstructPackage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Package name to add as dependency for the base construct</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-example">
+<h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;aws-cdk-lib&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div>
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;aws-cdk-lib&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="esbuildoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>esbuild<wbr/>Options</span><a href="#esbuildoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">esbuildOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildOptions</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">esbuildOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildOptions</span></div>
+<div class="tsd-comment tsd-typography"><p>esbuild options to customize the bundling process</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-4">Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">{}</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="filepattern"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>file<wbr/>Pattern</span><a href="#filepattern" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">filePattern</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">filePattern</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>File pattern to identify Lambda Function handlers</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-5">Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;*.lambda.ts&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="outputdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>output<wbr/>Dir</span><a href="#outputdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">outputDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">outputDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Output directory where Lambda Function constructs will be generated</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-6">Default<a href="#default-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;src/constructs/lambda&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="sourcedir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>source<wbr/>Dir</span><a href="#sourcedir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">sourceDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section></section></details></div>
+<div class="tsd-signature"><span class="tsd-kind-property">sourceDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Source directory where Lambda Function handlers are located</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-7">Default<a href="#default-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;src/handlers&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section></section></details></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/api/interfaces/LocalStackOptions.html

@@ -10,6 +10,9 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">LocalStackOptions</a></li></ul>
 <h1>Interface LocalStackOptions</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Options for LocalStack component.</p>
+</div></section>
 <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LocalStackOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#debug">debug</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#imagetag">imageTag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#port">port</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#services">services</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
@@ -28,16 +31,55 @@
 <section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="debug"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
+<div class="tsd-comment tsd-typography"><p>Enable LocalStack debug mode.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="imagetag"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>image<wbr/>Tag</span><a href="#imagetag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">imageTag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">imageTag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>LocalStack Docker image tag, e.g. <code>&quot;4.9&quot;</code> to pin a version.</p>
+<p>When set, LocalStack starts with the <code>localstack/localstack:&lt;imageTag&gt;</code> image, passed to
+<code>localstack start</code> through the <code>IMAGE_NAME</code> environment variable. That's the community
+image, even if a <code>LOCALSTACK_AUTH_TOKEN</code> would otherwise select the Pro image.</p>
+<p>Must be a valid Docker tag.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">LocalStack</span><span class="hl-1"> </span><span class="hl-4">CLI</span><span class="hl-2">&#39;s default imag</span><span class="hl-9">e</span>
+</code><button type="button">Copy</button></pre>
+
+</div>
+<div class="tsd-tag-see">
+<h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://docs.localstack.cloud/aws/customization/configuration-options/">https://docs.localstack.cloud/aws/customization/configuration-options/</a></p>
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="port"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>port</span><a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
+<div class="tsd-comment tsd-typography"><p>LocalStack gateway port.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">4566</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="services"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>services</span><a href="#services" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">services</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div></section></section></details></div>
+<div class="tsd-signature"><span class="tsd-kind-property">services</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
+<div class="tsd-comment tsd-typography"><p>LocalStack services to enable.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-default">
+<h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">all</span><span class="hl-1"> </span><span class="hl-5">services</span><span class="hl-1"> </span><span class="hl-5">enabled</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section></section></details></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/lib/components/bundle-lambda-function-code.d.ts

@@ -1,60 +1,303 @@
 import { Component, cdk, type Project, type Task } from "projen";
+/**
+ * Renders the bundle name of an entrypoint: its path without the extension and without a leading `src` directory.
+ *
+ * @example renderBundleName("src/handlers/foo.lambda.ts") // "handlers/foo.lambda"
+ */
 export declare function renderBundleName(entrypoint: string): string;
+/**
+ * Converts the given path string to posix if it wasn't already.
+ */
 export declare function convertToPosixPath(p: string): string;
+/**
+ * Options for `Bundler`.
+ */
 export interface BundlerOptions {
+    /**
+     * The semantic version requirement for `esbuild`.
+     *
+     * @default - no specific version (implies latest)
+     */
     readonly esbuildVersion?: string;
+    /**
+     * Output directory for all bundles.
+     *
+     * @default "assets"
+     */
     readonly assetsDir?: string;
+    /**
+     * Install the `bundle` command as a pre-compile phase.
+     *
+     * @default true
+     */
     readonly addToPreCompile?: boolean;
+    /**
+     * Map of file extensions (without dot) and loaders to use for this file type.
+     * Loaders are appended to the esbuild command by `--loader:.extension=loader`
+     *
+     * @default - no loaders
+     */
     readonly loaders?: {
         [key: string]: string;
     };
 }
+/**
+ * Adds support for bundling JavaScript applications and dependencies into a
+ * single file.
+ */
 export declare class Bundler extends Component {
+    /**
+     * Returns the `Bundler` instance associated with a project or `undefined` if
+     * there is no Bundler.
+     *
+     * @param project The project
+     * @returns A bundler
+     */
     static of(project: Project): Bundler | undefined;
+    /**
+     * The semantic version requirement for `esbuild` (if defined).
+     */
     readonly esbuildVersion: string | undefined;
+    /**
+     * Root bundle directory.
+     */
     readonly bundledir: string;
     private _task;
     private readonly addToPreCompile;
     private readonly loaders?;
+    /**
+     * Creates a `Bundler`.
+     */
     constructor(project: Project, options?: BundlerOptions);
+    /**
+     * Gets or creates the singleton "bundle" task of the project.
+     *
+     * If the project doesn't have a "bundle" task, it will be created and spawned
+     * during the pre-compile phase (unless `addToPreCompile` is `false`).
+     */
     get bundleTask(): Task;
+    /**
+     * Adds a task to the project which bundles a specific entrypoint and all of
+     * its dependencies into a single javascript output file.
+     *
+     * @param entrypoint The relative path of the artifact within the project
+     * @param options Bundling options
+     */
     addBundle(entrypoint: string, options: BundlingOptions): Bundle;
+    /**
+     * Add bundling support to a project. This is called implicitly when
+     * `bundleTask` is referenced first. It adds the dependency on `esbuild`,
+     * gitignore/npmignore, etc.
+     */
     private addBundlingSupport;
 }
+/**
+ * A bundle created by `Bundler.addBundle`.
+ */
 export interface Bundle {
+    /**
+     * The task that produces this bundle.
+     */
     readonly bundleTask: Task;
+    /**
+     * Location of the output file (relative to project root).
+     */
     readonly outfile: string;
+    /**
+     * Base directory containing the output file (relative to project root).
+     */
     readonly outdir: string;
 }
+/**
+ * Options for bundling.
+ */
 export interface BundlingOptions {
+    /**
+     * You can mark a file or a package as external to exclude it from your build.
+     * Instead of being bundled, the import will be preserved (using require for
+     * the iife and cjs formats and using import for the esm format) and will be
+     * evaluated at run time instead.
+     *
+     * This has several uses. First of all, it can be used to trim unnecessary
+     * code from your bundle for a code path that you know will never be executed.
+     * For example, a package may contain code that only runs in node but you will
+     * only be using that package in the browser. It can also be used to import
+     * code in node at run time from a package that cannot be bundled. For
+     * example, the fsevents package contains a native extension, which esbuild
+     * doesn't support.
+     *
+     * @default []
+     */
     readonly externals?: string[];
+    /**
+     * Include a source map in the bundle.
+     *
+     * @default true
+     */
     readonly sourcemap?: boolean;
+    /**
+     * esbuild target.
+     *
+     * @default "esnext"
+     */
     readonly target?: string;
+    /**
+     * esbuild platform.
+     *
+     * @default "node"
+     */
     readonly platform?: string;
+    /**
+     * Bundler output path relative to the asset's output directory.
+     *
+     * @default "index.mjs"
+     */
     readonly outfile?: string;
+    /**
+     * The path of the tsconfig.json file to use for bundling.
+     *
+     * `LambdaFunctionCodeBundle` always sets this to the project's development tsconfig.
+     *
+     * @default - no tsconfig is passed to esbuild
+     */
     readonly tsconfigPath?: string;
+    /**
+     * Map of file extensions (without dot) and loaders to use for this file type.
+     * Loaders are appended to the esbuild command by `--loader:.extension=loader`
+     *
+     * @default - the loaders of the `Bundler`
+     */
     readonly loaders?: {
         [key: string]: string;
     };
+    /**
+     * Output format for the generated JavaScript files: `"iife"`, `"cjs"` or `"esm"`.
+     *
+     * @default "esm"
+     * @see https://esbuild.github.io/api/#format
+     */
     readonly format?: string;
+    /**
+     * Minify the bundle.
+     *
+     * @default true
+     * @see https://esbuild.github.io/api/#minify
+     */
     readonly minify?: boolean;
+    /**
+     * Include the original source code in the source map.
+     *
+     * @default false
+     * @see https://esbuild.github.io/api/#sources-content
+     */
     readonly sourcesContent?: boolean;
+    /**
+     * Comma-separated list of `package.json` fields esbuild tries when resolving a package.
+     *
+     * @default "module,main"
+     * @see https://esbuild.github.io/api/#main-fields
+     */
     readonly mainFields?: string;
+    /**
+     * esbuild `--banner` argument, appended as is (so it starts with the file type, e.g. `:js=`).
+     *
+     * The default defines `require` so that CommonJS dependencies work in an ES module bundle.
+     *
+     * @default ":js=import { createRequire as topLevelCreateRequire } from 'module';const require = topLevelCreateRequire(import.meta.url)"
+     * @see https://esbuild.github.io/api/#banner
+     */
     readonly banner?: string;
 }
+/**
+ * Options for `LambdaFunctionCodeBundle`.
+ */
 export interface LambdaFunctionCodeBundleOptions {
+    /**
+     * A path from the project root directory to a TypeScript file which contains
+     * the AWS Lambda handler entrypoint (exports a `handler` function).
+     *
+     * This is relative to the root directory of the project.
+     *
+     * @example "src/subdir/foo.lambda.ts"
+     */
     readonly entrypoint: string;
+    /**
+     * Suffix for AWS Lambda handlers.
+     *
+     * @example ".lambda.ts"
+     */
     readonly extension: string;
+    /**
+     * The name of the generated TypeScript source file. This file should also be
+     * under the source tree.
+     *
+     * @default - The path of the entrypoint file, with the `-code.ts` suffix
+     * instead of the extension (e.g. `src/foo-code.ts`).
+     */
     readonly constructFile?: string;
+    /**
+     * The name of the generated `aws_lambda.Code` constant.
+     *
+     * @default - A pascal cased version of the name of the entrypoint file, with
+     * the suffix `FunctionCode` (e.g. `ResizeImageFunctionCode`).
+     */
     readonly constructName?: string;
+    /**
+     * Bundling options for this AWS Lambda Function.
+     *
+     * @default - the defaults of `BundlingOptions`
+     */
     readonly bundlingOptions?: BundlingOptions;
 }
+/**
+ * Generates a pre-bundled AWS Lambda Function code asset from handler code.
+ *
+ * Adds a task to the project's `Bundler` that uses `esbuild` to bundle the
+ * handler into the assets directory, and generates a file (e.g. `src/foo-code.ts`)
+ * exporting an `aws_lambda.Code` constant (e.g. `FooFunctionCode`) that points to
+ * the bundle. Pass it as the `code` of an `aws_lambda.Function`.
+ *
+ * Requires a `Bundler` component in the project.
+ *
+ * @example
+ *
+ * new Bundler(myProject);
+ * new LambdaFunctionCodeBundle(myProject, {
+ *   entrypoint: "src/foo.lambda.ts",
+ *   extension: ".lambda.ts",
+ * });
+ */
 export declare class LambdaFunctionCodeBundle extends Component {
+    /**
+     * Defines a pre-bundled AWS Lambda Function code asset from handler code.
+     *
+     * @param project The project to use
+     * @param options Options
+     */
     constructor(project: Project, options: LambdaFunctionCodeBundleOptions);
 }
+/**
+ * Options for `LambdaFunctionCodeBundler`
+ */
 export interface LambdaFunctionCodeBundlerOptions {
+    /**
+     * Locate files with the given extension.
+     *
+     * @example ".lambda.ts"
+     */
     readonly extension: string;
+    /**
+     * Project source tree (relative to project output directory).
+     */
     readonly srcdir: string;
+    /**
+     * Options for AWS Lambda Function bundling, applied to every discovered entrypoint.
+     *
+     * The `entrypoint` and `extension` given here are ignored: each bundle uses its
+     * discovered entrypoint and the `extension` of the bundler.
+     *
+     * @default - the defaults of `LambdaFunctionCodeBundleOptions`
+     */
     readonly bundleOptions?: LambdaFunctionCodeBundleOptions;
 }
 /**