cdk-serverless 2.22.3 → 2.22.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/constructs/assets/icons.js +1 -1
- package/docs/constructs/assets/icons.svg +1 -1
- package/docs/constructs/assets/main.js +3 -3
- package/docs/lambda/assets/icons.js +1 -1
- package/docs/lambda/assets/icons.svg +1 -1
- package/docs/lambda/assets/main.js +3 -3
- package/docs/projen/assets/icons.js +1 -1
- package/docs/projen/assets/icons.svg +1 -1
- package/docs/projen/assets/main.js +3 -3
- package/docs/projen/classes/Datastore.html +1 -1
- package/docs/projen/classes/GraphQlApi.html +1 -1
- package/docs/projen/classes/RestApi.html +1 -1
- package/docs/projen/classes/ServerlessProject.html +10 -10
- package/docs/projen/classes/Workflow.html +1 -1
- package/docs/projen/interfaces/ServerlessProjectOptions.html +188 -167
- package/lib/constructs/authentication.js +2 -2
- package/lib/constructs/graphql.js +3 -3
- package/lib/constructs/rest-api.js +2 -2
- package/lib/projen/core.js +1 -3
- package/lib/projen/datastore.js +6 -7
- package/lib/projen/lazy-sampledir.js +9 -9
- package/lib/projen/rest-api.js +4 -4
- package/lib/projen/workflow.js +4 -4
- package/package.json +40 -36
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerlessProjectOptions | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ServerlessProjectOptions</a></li></ul><h1>Interface ServerlessProjectOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ServerlessProjectOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#allowlibrarydependencies">allowLibraryDependencies</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="#app">app</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="#appentrypoint">appEntrypoint</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="#artifactsdirectory">artifactsDirectory</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="#auditdeps">auditDeps</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="#auditdepsoptions">auditDepsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AuditOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authoremail">authorEmail</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="#authorname">authorName</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="#authororganization">authorOrganization</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="#authorurl">authorUrl</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="#autoapproveoptions">autoApproveOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApproveOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autoapproveupgrades">autoApproveUpgrades</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="#autodetectbin">autoDetectBin</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="#automerge">autoMerge</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="#automergeoptions">autoMergeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMergeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bin">bin</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><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/> <a class="tsd-kind-property" href="#biome">biome</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="#biomeoptions">biomeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BiomeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bugsemail">bugsEmail</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="#bugsurl">bugsUrl</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="#buildcommand">buildCommand</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="#buildworkflow">buildWorkflow</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="#buildworkflowoptions">buildWorkflowOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflowOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buildworkflowtriggers">buildWorkflowTriggers</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Triggers</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bumppackage">bumpPackage</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="#bundleddeps">bundledDeps</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/> <a class="tsd-kind-property" href="#bundleroptions">bundlerOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BundlerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bunversion">bunVersion</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="#cdkassert">cdkAssert</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="#cdkassertions">cdkAssertions</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="#cdkcliversion">cdkCliVersion</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="#cdkdependencies">cdkDependencies</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/> <a class="tsd-kind-property" href="#cdkdependenciesasdeps">cdkDependenciesAsDeps</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="#cdkout">cdkout</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="#cdktestdependencies">cdkTestDependencies</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/> <a class="tsd-kind-property" href="#cdkversion">cdkVersion</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="#cdkversionpinning">cdkVersionPinning</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="#checklicenses">checkLicenses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LicenseCheckerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clobber">clobber</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="#codeartifactoptions">codeArtifactOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CodeArtifactOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codecov">codeCov</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="#codecovtokensecret">codeCovTokenSecret</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="#commitgenerated">commitGenerated</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="#constructsversion">constructsVersion</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="#context">context</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyrightowner">copyrightOwner</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="#copyrightperiod">copyrightPeriod</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="#defaultreleasebranch">defaultReleaseBranch</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="#dependabot">dependabot</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="#dependabotoptions">dependabotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependabotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deps">deps</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/> <a class="tsd-kind-property" href="#depsupgrade">depsUpgrade</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="#depsupgradeoptions">depsUpgradeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependenciesOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#description">description</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="#devcontainer">devContainer</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="#devdeps">devDeps</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/> <a class="tsd-kind-property" href="#disabletsconfig">disableTsconfig</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="#disabletsconfigdev">disableTsconfigDev</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="#docgen">docgen</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="#docsdirectory">docsDirectory</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="#edgelambdaautodiscover">edgeLambdaAutoDiscover</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="#entrypoint">entrypoint</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="#entrypointtypes">entrypointTypes</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="#eslint">eslint</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="#eslintoptions">eslintOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">EslintOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#experimentalintegrunner">experimentalIntegRunner</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="#featureflags">featureFlags</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ICdkFeatureFlags</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#github">github</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="#githuboptions">githubOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitHubOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitignore">gitignore</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/> <a class="tsd-kind-property" href="#gitignoreoptions">gitIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitoptions">gitOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitpod">gitpod</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="#homepage">homepage</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="#integrationtestautodiscover">integrationTestAutoDiscover</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="#jest">jest</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="#jestoptions">jestOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JestOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsiireleaseversion">jsiiReleaseVersion</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="#keywords">keywords</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/> <a class="tsd-kind-property" href="#lambdaautodiscover">lambdaAutoDiscover</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="#lambdaextensionautodiscover">lambdaExtensionAutoDiscover</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="#lambdaoptions">lambdaOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LambdaFunctionCommonOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#libdir">libdir</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="#license">license</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="#licensed">licensed</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="#logging">logging</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoggerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#majorversion">majorVersion</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="#maxnodeversion">maxNodeVersion</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="#mergify">mergify</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="#mergifyoptions">mergifyOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MergifyOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minmajorversion">minMajorVersion</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="#minnodeversion">minNodeVersion</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="#mutablebuild">mutableBuild</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="#name">name</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="#nextversioncommand">nextVersionCommand</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="#npmaccess">npmAccess</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NpmAccess</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmdisttag">npmDistTag</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="#npmignore">npmignore</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/> <a class="tsd-kind-property" href="#npmignoreenabled">npmignoreEnabled</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="#npmignoreoptions">npmIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmprovenance">npmProvenance</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="#npmregistry">npmRegistry</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="#npmregistryurl">npmRegistryUrl</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="#npmtokensecret">npmTokenSecret</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="#npmtrustedpublishing">npmTrustedPublishing</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="#outdir">outdir</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="#package">package</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="#packagemanager">packageManager</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NodePackageManager</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#packagename">packageName</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="#parent">parent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdependencyoptions">peerDependencyOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerDependencyOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdeps">peerDeps</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/> <a class="tsd-kind-property" href="#pnpmversion">pnpmVersion</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="#postbuildsteps">postBuildSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prerelease">prerelease</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="#prettier">prettier</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="#prettieroptions">prettierOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PrettierOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projecttree">projectTree</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="#projecttype">projectType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjectType</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projencommand">projenCommand</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="#projencredentials">projenCredentials</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GithubCredentials</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projendevdependency">projenDevDependency</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="#projenrcjs">projenrcJs</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="#projenrcjson">projenrcJson</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="#projenrcjsonoptions">projenrcJsonOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcJsonOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjsoptions">projenrcJsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcts">projenrcTs</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="#projenrctsoptions">projenrcTsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projentokensecret">projenTokenSecret</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="#projenversion">projenVersion</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="#publishdryrun">publishDryRun</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="#publishtasks">publishTasks</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="#pullrequesttemplate">pullRequestTemplate</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="#pullrequesttemplatecontents">pullRequestTemplateContents</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/> <a class="tsd-kind-property" href="#readme">readme</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SampleReadmeProps</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasablecommits">releasableCommits</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleasableCommits</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#release">release</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="#releasebranches">releaseBranches</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">BranchOptions</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseenvironment">releaseEnvironment</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="#releaseeverycommit">releaseEveryCommit</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="#releasefailureissue">releaseFailureIssue</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="#releasefailureissuelabel">releaseFailureIssueLabel</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="#releaseschedule">releaseSchedule</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="#releasetagprefix">releaseTagPrefix</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="#releasetonpm">releaseToNpm</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="#releasetrigger">releaseTrigger</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleaseTrigger</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflow">releaseWorkflow</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="#releaseworkflowenv">releaseWorkflowEnv</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/> <a class="tsd-kind-property" href="#releaseworkflowname">releaseWorkflowName</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="#releaseworkflowsetupsteps">releaseWorkflowSetupSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#renovatebot">renovatebot</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="#renovatebotoptions">renovatebotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenovatebotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repository">repository</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="#repositorydirectory">repositoryDirectory</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="#requireapproval">requireApproval</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ApprovalLevel</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#samplecode">sampleCode</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="#scopedpackagesoptions">scopedPackagesOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scripts">scripts</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/> <a class="tsd-kind-property" href="#singletonlambdaautodiscover">singletonLambdaAutoDiscover</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="#srcdir">srcdir</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="#stability">stability</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="#stale">stale</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="#staleoptions">staleOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaleOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#testdir">testdir</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="#tsconfig">tsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdev">tsconfigDev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdevfile">tsconfigDevFile</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="#tsjestoptions">tsJestOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TsJestOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typescriptversion">typescriptVersion</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="#versionrcoptions">versionrcOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vscode">vscode</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="#watchexcludes">watchExcludes</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/> <a class="tsd-kind-property" href="#watchincludes">watchIncludes</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/> <a class="tsd-kind-property" href="#workflowbootstrapsteps">workflowBootstrapSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowcontainerimage">workflowContainerImage</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="#workflowgitidentity">workflowGitIdentity</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitIdentity</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflownodeversion">workflowNodeVersion</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="#workflowpackagecache">workflowPackageCache</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="#workflowrunson">workflowRunsOn</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/> <a class="tsd-kind-property" href="#workflowrunsongroup">workflowRunsOnGroup</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GroupRunnerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yarnberryoptions">yarnBerryOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">YarnBerryOptions</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="2"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">AwsCdkTypeScriptAppOptions</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ServerlessProjectOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#allowlibrarydependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerlessProjectOptions | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ServerlessProjectOptions</a></li></ul><h1>Interface ServerlessProjectOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ServerlessProjectOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#addpackagemanagertodevengines">addPackageManagerToDevEngines</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="#allowlibrarydependencies">allowLibraryDependencies</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="#app">app</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="#appentrypoint">appEntrypoint</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="#artifactsdirectory">artifactsDirectory</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="#auditdeps">auditDeps</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="#auditdepsoptions">auditDepsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AuditOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authoremail">authorEmail</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="#authorname">authorName</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="#authororganization">authorOrganization</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="#authorurl">authorUrl</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="#autoapproveoptions">autoApproveOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApproveOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autoapproveupgrades">autoApproveUpgrades</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="#autodetectbin">autoDetectBin</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="#automerge">autoMerge</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="#automergeoptions">autoMergeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMergeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bin">bin</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><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/> <a class="tsd-kind-property" href="#biome">biome</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="#biomeoptions">biomeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BiomeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bugsemail">bugsEmail</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="#bugsurl">bugsUrl</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="#buildcommand">buildCommand</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="#buildworkflow">buildWorkflow</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="#buildworkflowoptions">buildWorkflowOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflowOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buildworkflowtriggers">buildWorkflowTriggers</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Triggers</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bumppackage">bumpPackage</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="#bundleddeps">bundledDeps</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/> <a class="tsd-kind-property" href="#bundleroptions">bundlerOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BundlerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bunversion">bunVersion</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="#cdkassert">cdkAssert</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="#cdkassertions">cdkAssertions</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="#cdkcliversion">cdkCliVersion</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="#cdkdependencies">cdkDependencies</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/> <a class="tsd-kind-property" href="#cdkdependenciesasdeps">cdkDependenciesAsDeps</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="#cdkout">cdkout</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="#cdktestdependencies">cdkTestDependencies</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/> <a class="tsd-kind-property" href="#cdkversion">cdkVersion</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="#cdkversionpinning">cdkVersionPinning</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="#checklicenses">checkLicenses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LicenseCheckerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clobber">clobber</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="#codeartifactoptions">codeArtifactOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CodeArtifactOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codecov">codeCov</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="#codecovtokensecret">codeCovTokenSecret</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="#commitgenerated">commitGenerated</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="#constructsversion">constructsVersion</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="#context">context</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyrightowner">copyrightOwner</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="#copyrightperiod">copyrightPeriod</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="#defaultreleasebranch">defaultReleaseBranch</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="#deleteorphanedlockfiles">deleteOrphanedLockFiles</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="#dependabot">dependabot</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="#dependabotoptions">dependabotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependabotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deps">deps</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/> <a class="tsd-kind-property" href="#depsupgrade">depsUpgrade</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="#depsupgradeoptions">depsUpgradeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependenciesOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#description">description</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="#devcontainer">devContainer</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="#devdeps">devDeps</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/> <a class="tsd-kind-property" href="#devengines">devEngines</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DevEngines</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabletsconfig">disableTsconfig</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="#disabletsconfigdev">disableTsconfigDev</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="#docgen">docgen</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="#docsdirectory">docsDirectory</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="#edgelambdaautodiscover">edgeLambdaAutoDiscover</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="#entrypoint">entrypoint</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="#entrypointtypes">entrypointTypes</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="#eslint">eslint</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="#eslintoptions">eslintOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">EslintOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#experimentalintegrunner">experimentalIntegRunner</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="#featureflags">featureFlags</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ICdkFeatureFlags</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#github">github</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="#githuboptions">githubOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitHubOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitignore">gitignore</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/> <a class="tsd-kind-property" href="#gitignoreoptions">gitIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitoptions">gitOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitpod">gitpod</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="#homepage">homepage</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="#integrationtestautodiscover">integrationTestAutoDiscover</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="#jest">jest</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="#jestoptions">jestOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JestOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsiireleaseversion">jsiiReleaseVersion</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="#keywords">keywords</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/> <a class="tsd-kind-property" href="#lambdaautodiscover">lambdaAutoDiscover</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="#lambdaextensionautodiscover">lambdaExtensionAutoDiscover</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="#lambdaoptions">lambdaOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LambdaFunctionCommonOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#libdir">libdir</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="#license">license</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="#licensed">licensed</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="#logging">logging</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoggerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#majorversion">majorVersion</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="#maxnodeversion">maxNodeVersion</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="#mergify">mergify</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="#mergifyoptions">mergifyOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MergifyOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minmajorversion">minMajorVersion</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="#minnodeversion">minNodeVersion</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="#mutablebuild">mutableBuild</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="#name">name</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="#nextversioncommand">nextVersionCommand</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="#npmaccess">npmAccess</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NpmAccess</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmdisttag">npmDistTag</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="#npmignore">npmignore</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/> <a class="tsd-kind-property" href="#npmignoreenabled">npmignoreEnabled</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="#npmignoreoptions">npmIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmprovenance">npmProvenance</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="#npmregistry">npmRegistry</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="#npmregistryurl">npmRegistryUrl</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="#npmtokensecret">npmTokenSecret</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="#npmtrustedpublishing">npmTrustedPublishing</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="#outdir">outdir</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="#package">package</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="#packagemanager">packageManager</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NodePackageManager</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#packagename">packageName</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="#parent">parent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdependencyoptions">peerDependencyOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerDependencyOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdeps">peerDeps</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/> <a class="tsd-kind-property" href="#pnpmversion">pnpmVersion</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="#postbuildsteps">postBuildSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prerelease">prerelease</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="#prettier">prettier</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="#prettieroptions">prettierOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PrettierOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projecttree">projectTree</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="#projecttype">projectType</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjectType</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projencommand">projenCommand</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="#projencredentials">projenCredentials</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GithubCredentials</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projendevdependency">projenDevDependency</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="#projenrcjs">projenrcJs</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="#projenrcjson">projenrcJson</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="#projenrcjsonoptions">projenrcJsonOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcJsonOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjsoptions">projenrcJsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcts">projenrcTs</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="#projenrctsoptions">projenrcTsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projentokensecret">projenTokenSecret</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="#projenversion">projenVersion</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="#publishdryrun">publishDryRun</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="#publishtasks">publishTasks</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="#pullrequesttemplate">pullRequestTemplate</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="#pullrequesttemplatecontents">pullRequestTemplateContents</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/> <a class="tsd-kind-property" href="#readme">readme</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SampleReadmeProps</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasablecommits">releasableCommits</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleasableCommits</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#release">release</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="#releasebranches">releaseBranches</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">BranchOptions</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseenvironment">releaseEnvironment</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="#releaseeverycommit">releaseEveryCommit</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="#releasefailureissue">releaseFailureIssue</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="#releasefailureissuelabel">releaseFailureIssueLabel</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="#releaseschedule">releaseSchedule</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="#releasetagprefix">releaseTagPrefix</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="#releasetonpm">releaseToNpm</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="#releasetrigger">releaseTrigger</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleaseTrigger</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflow">releaseWorkflow</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="#releaseworkflowenv">releaseWorkflowEnv</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/> <a class="tsd-kind-property" href="#releaseworkflowname">releaseWorkflowName</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="#releaseworkflowsetupsteps">releaseWorkflowSetupSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#renovatebot">renovatebot</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="#renovatebotoptions">renovatebotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenovatebotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repository">repository</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="#repositorydirectory">repositoryDirectory</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="#requireapproval">requireApproval</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ApprovalLevel</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#samplecode">sampleCode</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="#scopedpackagesoptions">scopedPackagesOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scripts">scripts</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/> <a class="tsd-kind-property" href="#singletonlambdaautodiscover">singletonLambdaAutoDiscover</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="#srcdir">srcdir</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="#stability">stability</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="#stale">stale</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="#staleoptions">staleOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaleOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#testdir">testdir</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="#tsconfig">tsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdev">tsconfigDev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdevfile">tsconfigDevFile</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="#tsjestoptions">tsJestOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TsJestOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typescriptversion">typescriptVersion</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="#versionrcoptions">versionrcOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vscode">vscode</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="#watchexcludes">watchExcludes</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/> <a class="tsd-kind-property" href="#watchincludes">watchIncludes</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/> <a class="tsd-kind-property" href="#workflowbootstrapsteps">workflowBootstrapSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowcontainerimage">workflowContainerImage</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="#workflowgitidentity">workflowGitIdentity</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitIdentity</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflownodeversion">workflowNodeVersion</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="#workflowpackagecache">workflowPackageCache</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="#workflowrunson">workflowRunsOn</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/> <a class="tsd-kind-property" href="#workflowrunsongroup">workflowRunsOnGroup</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GroupRunnerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yarnberryoptions">yarnBerryOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">YarnBerryOptions</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="2"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">AwsCdkTypeScriptAppOptions</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ServerlessProjectOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#addpackagemanagertodevengines" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines?</span></a>
|
|
2
|
+
<a href="#allowlibrarydependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
2
3
|
<a href="#app" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app?</span></a>
|
|
3
4
|
<a href="#appentrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint?</span></a>
|
|
4
5
|
<a href="#artifactsdirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory?</span></a>
|
|
@@ -46,6 +47,7 @@
|
|
|
46
47
|
<a href="#copyrightowner" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Owner?</span></a>
|
|
47
48
|
<a href="#copyrightperiod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Period?</span></a>
|
|
48
49
|
<a href="#defaultreleasebranch" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a>
|
|
50
|
+
<a href="#deleteorphanedlockfiles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files?</span></a>
|
|
49
51
|
<a href="#dependabot" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot?</span></a>
|
|
50
52
|
<a href="#dependabotoptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot<wbr/>Options?</span></a>
|
|
51
53
|
<a href="#deps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps?</span></a>
|
|
@@ -54,6 +56,7 @@
|
|
|
54
56
|
<a href="#description" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description?</span></a>
|
|
55
57
|
<a href="#devcontainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container?</span></a>
|
|
56
58
|
<a href="#devdeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Deps?</span></a>
|
|
59
|
+
<a href="#devengines" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Engines?</span></a>
|
|
57
60
|
<a href="#disabletsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig?</span></a>
|
|
58
61
|
<a href="#disabletsconfigdev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev?</span></a>
|
|
59
62
|
<a href="#docgen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen?</span></a>
|
|
@@ -179,32 +182,37 @@
|
|
|
179
182
|
<a href="#workflowrunson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On?</span></a>
|
|
180
183
|
<a href="#workflowrunsongroup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On<wbr/>Group?</span></a>
|
|
181
184
|
<a href="#yarnberryoptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options?</span></a>
|
|
182
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="
|
|
185
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addpackagemanagertodevengines"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines</span><a href="#addpackagemanagertodevengines" 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">addPackageManagerToDevEngines</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically add the resolved <code>packageManager</code> to <code>devEngines.packageManager</code>
|
|
186
|
+
in <code>package.json</code>, setting <code>onFail</code> to <code>ignore</code>.</p>
|
|
187
|
+
</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-5">true</span>
|
|
188
|
+
</code><button type="button">Copy</button></pre>
|
|
189
|
+
|
|
190
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.addPackageManagerToDevEngines</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="allowlibrarydependencies"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowlibrarydependencies" 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">allowLibraryDependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Allow the project to include <code>peerDependencies</code> and <code>bundledDependencies</code>.
|
|
183
191
|
This is normally only allowed for libraries. For apps, there's no meaning
|
|
184
192
|
for specifying these.</p>
|
|
185
|
-
</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-5">true</span>
|
|
193
|
+
</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-5">true</span>
|
|
186
194
|
</code><button type="button">Copy</button></pre>
|
|
187
195
|
|
|
188
196
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.allowLibraryDependencies</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="app"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>app</span><a href="#app" 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">app</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The command line to execute in order to synthesize the CDK application
|
|
189
197
|
(language specific).</p>
|
|
190
198
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.app</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="appentrypoint"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>app<wbr/>Entrypoint</span><a href="#appentrypoint" 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">appEntrypoint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CDK app's entrypoint (relative to the source directory, which is
|
|
191
199
|
"src" by default).</p>
|
|
192
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
200
|
+
</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-2">"main.ts"</span>
|
|
193
201
|
</code><button type="button">Copy</button></pre>
|
|
194
202
|
|
|
195
203
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.appEntrypoint</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="artifactsdirectory"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>artifacts<wbr/>Directory</span><a href="#artifactsdirectory" 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">artifactsDirectory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A directory which will contain build artifacts.</p>
|
|
196
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
204
|
+
</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-2">"dist"</span>
|
|
197
205
|
</code><button type="button">Copy</button></pre>
|
|
198
206
|
|
|
199
207
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.artifactsDirectory</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="auditdeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>audit<wbr/>Deps</span><a href="#auditdeps" 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">auditDeps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Run security audit on dependencies.</p>
|
|
200
208
|
<p>When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
201
209
|
in dependencies. By default, runs during every build and checks for "high" severity
|
|
202
210
|
vulnerabilities or above in all dependencies (including dev dependencies).</p>
|
|
203
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
211
|
+
</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-5">false</span>
|
|
204
212
|
</code><button type="button">Copy</button></pre>
|
|
205
213
|
|
|
206
214
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.auditDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="auditdepsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>audit<wbr/>Deps<wbr/>Options</span><a href="#auditdepsoptions" 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">auditDepsOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AuditOptions</span></div><div class="tsd-comment tsd-typography"><p>Security audit options.</p>
|
|
207
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
215
|
+
</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-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
208
216
|
</code><button type="button">Copy</button></pre>
|
|
209
217
|
|
|
210
218
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.auditDepsOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="authoremail"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Email</span><a href="#authoremail" 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">authorEmail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Author's e-mail</p>
|
|
@@ -212,28 +220,28 @@ vulnerabilities or above in all dependencies (including dev dependencies).</p>
|
|
|
212
220
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorName</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="authororganization"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Organization</span><a href="#authororganization" 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">authorOrganization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Is the author an organization</p>
|
|
213
221
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorOrganization</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="authorurl"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Url</span><a href="#authorurl" 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">authorUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Author's URL / Website</p>
|
|
214
222
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorUrl</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="autoapproveoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Approve<wbr/>Options</span><a href="#autoapproveoptions" 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">autoApproveOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApproveOptions</span></div><div class="tsd-comment tsd-typography"><p>Enable and configure the 'auto approve' workflow.</p>
|
|
215
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
223
|
+
</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-1">- </span><span class="hl-4">auto</span><span class="hl-1"> </span><span class="hl-4">approve</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">disabled</span>
|
|
216
224
|
</code><button type="button">Copy</button></pre>
|
|
217
225
|
|
|
218
226
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="autoapproveupgrades"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Approve<wbr/>Upgrades</span><a href="#autoapproveupgrades" 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">autoApproveUpgrades</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically approve deps upgrade PRs, allowing them to be
|
|
219
227
|
merged by mergify (if configured).</p>
|
|
220
228
|
<p>Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
|
|
221
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
229
|
+
</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-1">- </span><span class="hl-5">true</span>
|
|
222
230
|
</code><button type="button">Copy</button></pre>
|
|
223
231
|
|
|
224
232
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveUpgrades</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="autodetectbin"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Detect<wbr/>Bin</span><a href="#autodetectbin" 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">autoDetectBin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically add all executables under the <code>bin</code> directory to your
|
|
225
233
|
<code>package.json</code> file under the <code>bin</code> section.</p>
|
|
226
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
234
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-8">Default<a href="#default-8" 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-5">true</span>
|
|
227
235
|
</code><button type="button">Copy</button></pre>
|
|
228
236
|
|
|
229
237
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoDetectBin</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="automerge"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Merge</span><a href="#automerge" 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">autoMerge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable automatic merging on GitHub. Has no effect if <code>github.mergify</code>
|
|
230
238
|
is set to false.</p>
|
|
231
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
239
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-9">Default<a href="#default-9" 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-5">true</span>
|
|
232
240
|
</code><button type="button">Copy</button></pre>
|
|
233
241
|
|
|
234
242
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMerge</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="automergeoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Merge<wbr/>Options</span><a href="#automergeoptions" 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">autoMergeOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMergeOptions</span></div><div class="tsd-comment tsd-typography"><p>Configure options for automatic merging on GitHub. Has no effect if
|
|
235
243
|
<code>github.mergify</code> or <code>autoMerge</code> is set to false.</p>
|
|
236
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
244
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-10">Default<a href="#default-10" 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><ul>
|
|
237
245
|
<li>see defaults in <code>AutoMergeOptions</code></li>
|
|
238
246
|
</ul>
|
|
239
247
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMergeOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bin"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bin</span><a href="#bin" 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">bin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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>Binary programs vended with your module.</p>
|
|
@@ -241,11 +249,11 @@ is set to false.</p>
|
|
|
241
249
|
your <code>package.json</code>, but unless <code>autoDetectBin</code> is <code>false</code>, every
|
|
242
250
|
executable file under <code>bin</code> will automatically be added to this section.</p>
|
|
243
251
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bin</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="biome"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>biome</span><a href="#biome" 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">biome</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Setup Biome.</p>
|
|
244
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
252
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-11">Default<a href="#default-11" 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-5">false</span>
|
|
245
253
|
</code><button type="button">Copy</button></pre>
|
|
246
254
|
|
|
247
255
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.biome</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="biomeoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>biome<wbr/>Options</span><a href="#biomeoptions" 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">biomeOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BiomeOptions</span></div><div class="tsd-comment tsd-typography"><p>Biome options</p>
|
|
248
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
256
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-12">Default<a href="#default-12" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
249
257
|
</code><button type="button">Copy</button></pre>
|
|
250
258
|
|
|
251
259
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.biomeOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bugsemail"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bugs<wbr/>Email</span><a href="#bugsemail" 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">bugsEmail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The email address to which issues should be reported.</p>
|
|
@@ -253,16 +261,16 @@ executable file under <code>bin</code> will automatically be added to this secti
|
|
|
253
261
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsUrl</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="buildcommand"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>build<wbr/>Command</span><a href="#buildcommand" 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">buildCommand</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A command to execute before synthesis. This command will be called when
|
|
254
262
|
running <code>cdk synth</code> or when <code>cdk watch</code> identifies a change in your source
|
|
255
263
|
code before redeployment.</p>
|
|
256
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
264
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-13">Default<a href="#default-13" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">build</span><span class="hl-1"> </span><span class="hl-4">command</span>
|
|
257
265
|
</code><button type="button">Copy</button></pre>
|
|
258
266
|
|
|
259
267
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildCommand</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="buildworkflow"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>build<wbr/>Workflow</span><a href="#buildworkflow" 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">buildWorkflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
|
|
260
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
268
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-14">Default<a href="#default-14" 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">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
|
|
261
269
|
</code><button type="button">Copy</button></pre>
|
|
262
270
|
|
|
263
271
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflow</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="buildworkflowoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>build<wbr/>Workflow<wbr/>Options</span><a href="#buildworkflowoptions" 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">buildWorkflowOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflowOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for PR build workflow.</p>
|
|
264
272
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflowOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="buildworkflowtriggers"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">build<wbr/>Workflow<wbr/>Triggers</span><a href="#buildworkflowtriggers" 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">buildWorkflowTriggers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Triggers</span></div><div class="tsd-comment tsd-typography"><p>Build workflow triggers</p>
|
|
265
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
273
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-15">Default<a href="#default-15" 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">"{ pullRequest: {}, workflowDispatch: {} }"</span>
|
|
266
274
|
</code><button type="button">Copy</button></pre>
|
|
267
275
|
|
|
268
276
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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><ul>
|
|
@@ -270,26 +278,26 @@ code before redeployment.</p>
|
|
|
270
278
|
</ul>
|
|
271
279
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflowTriggers</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bumppackage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bump<wbr/>Package</span><a href="#bumppackage" 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">bumpPackage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The <code>commit-and-tag-version</code> compatible package used to bump the package version, as a dependency string.</p>
|
|
272
280
|
<p>This can be any compatible package version, including the deprecated <code>standard-version@9</code>.</p>
|
|
273
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
281
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-16">Default<a href="#default-16" 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-7">A</span><span class="hl-1"> </span><span class="hl-4">recent</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-5">of</span><span class="hl-1"> </span><span class="hl-2">"commit-and-tag-version"</span>
|
|
274
282
|
</code><button type="button">Copy</button></pre>
|
|
275
283
|
|
|
276
284
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bumpPackage</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bundleddeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bundled<wbr/>Deps</span><a href="#bundleddeps" 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">bundledDeps</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>List of dependencies to bundle into this module. These modules will be
|
|
277
285
|
added both to the <code>dependencies</code> section and <code>bundledDependencies</code> section of
|
|
278
286
|
your <code>package.json</code>.</p>
|
|
279
287
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
280
|
-
<code>express</code>). This will behave similar to <code>
|
|
288
|
+
<code>express</code>). This will behave similar to <code>pnpm add</code> or <code>npm install</code> in the
|
|
281
289
|
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
282
290
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
283
|
-
the same syntax passed to <code>
|
|
284
|
-
this will be what
|
|
291
|
+
the same syntax passed to <code>pnpm add</code> or <code>npm i</code> (e.g. <code>express@^2</code>) and
|
|
292
|
+
this will be what your <code>package.json</code> will eventually include.</p>
|
|
285
293
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundledDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bundleroptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bundler<wbr/>Options</span><a href="#bundleroptions" 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">bundlerOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BundlerOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for <code>Bundler</code>.</p>
|
|
286
294
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundlerOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bunversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bun<wbr/>Version</span><a href="#bunversion" 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">bunVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The version of Bun to use if using Bun as a package manager.</p>
|
|
287
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
295
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-17">Default<a href="#default-17" 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">"latest"</span>
|
|
288
296
|
</code><button type="button">Copy</button></pre>
|
|
289
297
|
|
|
290
298
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bunVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkassert"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">cdk<wbr/>Assert</span><a href="#cdkassert" 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">cdkAssert</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Warning: NodeJS only.
|
|
291
299
|
Install the @aws-cdk/assert library?</p>
|
|
292
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
300
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-18">Default<a href="#default-18" 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-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">AWS</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> >= </span><span class="hl-8">1.0</span><span class="hl-1">.</span><span class="hl-8">0</span><span class="hl-1"> < </span><span class="hl-8">2.0</span><span class="hl-1">.</span><span class="hl-8">0</span>
|
|
293
301
|
</code><button type="button">Copy</button></pre>
|
|
294
302
|
|
|
295
303
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-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><p>The @aws-cdk/assert library is deprecated in favor of
|
|
@@ -297,14 +305,14 @@ Install the @aws-cdk/assert library?</p>
|
|
|
297
305
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssert</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkassertions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>cdk<wbr/>Assertions</span><a href="#cdkassertions" 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">cdkAssertions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Install the assertions library?</p>
|
|
298
306
|
<p>Only needed for CDK 1.x. If using CDK 2.x then
|
|
299
307
|
assertions is already included in 'aws-cdk-lib'</p>
|
|
300
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
308
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-19">Default<a href="#default-19" 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-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">AWS</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> >= </span><span class="hl-8">1.111</span><span class="hl-1">.</span><span class="hl-8">0</span><span class="hl-1"> < </span><span class="hl-8">2.0</span><span class="hl-1">.</span><span class="hl-8">0</span>
|
|
301
309
|
</code><button type="button">Copy</button></pre>
|
|
302
310
|
|
|
303
311
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssertions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkcliversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>cdk<wbr/>Cli<wbr/>Version</span><a href="#cdkcliversion" 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">cdkCliVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Version range of the AWS CDK CLI to depend on.</p>
|
|
304
312
|
<p>Can be either a specific version, or an NPM version range.</p>
|
|
305
313
|
<p>By default, the latest 2.x version will be installed; you can use this
|
|
306
314
|
option to restrict it to a specific version or version range.</p>
|
|
307
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
315
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-20">Default<a href="#default-20" 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">"^2"</span>
|
|
308
316
|
</code><button type="button">Copy</button></pre>
|
|
309
317
|
|
|
310
318
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkCliVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkdependencies"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">cdk<wbr/>Dependencies</span><a href="#cdkdependencies" 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">cdkDependencies</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>Which AWS CDKv1 modules this project requires</p>
|
|
@@ -316,18 +324,18 @@ when using npm < 7 or yarn, where peer dependencies are not automatically ins
|
|
|
316
324
|
If this is disabled, <code>cdkDependencies</code> will be added to <code>devDependencies</code> to ensure
|
|
317
325
|
they are present during development.</p>
|
|
318
326
|
<p>Note: this setting only applies to construct library projects</p>
|
|
319
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
327
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-21">Default<a href="#default-21" 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-5">true</span>
|
|
320
328
|
</code><button type="button">Copy</button></pre>
|
|
321
329
|
|
|
322
330
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-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><p>Not supported in CDK v2.</p>
|
|
323
331
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependenciesAsDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkout"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>cdkout</span><a href="#cdkout" 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">cdkout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>cdk.out directory.</p>
|
|
324
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
332
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-22">Default<a href="#default-22" 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">"cdk.out"</span>
|
|
325
333
|
</code><button type="button">Copy</button></pre>
|
|
326
334
|
|
|
327
335
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkout</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdktestdependencies"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">cdk<wbr/>Test<wbr/>Dependencies</span><a href="#cdktestdependencies" 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">cdkTestDependencies</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>AWS CDK modules required for testing.</p>
|
|
328
336
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-4">Deprecated<a href="#deprecated-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><p>For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead</p>
|
|
329
337
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkTestDependencies</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkversion"><code class="tsd-tag">Readonly</code><span>cdk<wbr/>Version</span><a href="#cdkversion" 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">cdkVersion</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Minimum version of the AWS CDK to depend on.</p>
|
|
330
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
338
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-23">Default<a href="#default-23" 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">"2.189.1"</span>
|
|
331
339
|
</code><button type="button">Copy</button></pre>
|
|
332
340
|
|
|
333
341
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="cdkversionpinning"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>cdk<wbr/>Version<wbr/>Pinning</span><a href="#cdkversionpinning" 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">cdkVersionPinning</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use pinned version instead of caret version for CDK.</p>
|
|
@@ -335,229 +343,241 @@ they are present during development.</p>
|
|
|
335
343
|
If you use experimental features this will let you define the moment you include breaking changes.</p>
|
|
336
344
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersionPinning</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="checklicenses"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>check<wbr/>Licenses</span><a href="#checklicenses" 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">checkLicenses</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LicenseCheckerOptions</span></div><div class="tsd-comment tsd-typography"><p>Configure which licenses should be deemed acceptable for use by dependencies</p>
|
|
337
345
|
<p>This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.</p>
|
|
338
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
346
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-24">Default<a href="#default-24" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">license</span><span class="hl-1"> </span><span class="hl-4">checks</span><span class="hl-1"> </span><span class="hl-4">are</span><span class="hl-1"> </span><span class="hl-4">run</span><span class="hl-1"> </span><span class="hl-4">during</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">build</span><span class="hl-1"> </span><span class="hl-4">and</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">licenses</span><span class="hl-1"> </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">accepted</span>
|
|
339
347
|
</code><button type="button">Copy</button></pre>
|
|
340
348
|
|
|
341
349
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.checkLicenses</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="clobber"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>clobber</span><a href="#clobber" 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">clobber</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
|
|
342
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
350
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-25">Default<a href="#default-25" 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">true</span><span class="hl-1">, </span><span class="hl-4">but</span><span class="hl-1"> </span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span>
|
|
343
351
|
</code><button type="button">Copy</button></pre>
|
|
344
352
|
|
|
345
353
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.clobber</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="codeartifactoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>code<wbr/>Artifact<wbr/>Options</span><a href="#codeartifactoptions" 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">codeArtifactOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CodeArtifactOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for npm packages using AWS CodeArtifact.
|
|
346
354
|
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
|
|
347
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
355
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-26">Default<a href="#default-26" 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">undefined</span>
|
|
348
356
|
</code><button type="button">Copy</button></pre>
|
|
349
357
|
|
|
350
358
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeArtifactOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="codecov"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>code<wbr/>Cov</span><a href="#codecov" 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">codeCov</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Define a GitHub workflow step for sending code coverage metrics to <a href="https://codecov.io/">https://codecov.io/</a>
|
|
351
359
|
Uses codecov/codecov-action@v5
|
|
352
360
|
By default, OIDC auth is used. Alternatively a token can be provided via <code>codeCovTokenSecret</code>.</p>
|
|
353
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
361
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-27">Default<a href="#default-27" 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-5">false</span>
|
|
354
362
|
</code><button type="button">Copy</button></pre>
|
|
355
363
|
|
|
356
364
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCov</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="codecovtokensecret"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><a href="#codecovtokensecret" 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">codeCovTokenSecret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Define the secret name for a specified <a href="https://codecov.io/">https://codecov.io/</a> token</p>
|
|
357
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
365
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-28">Default<a href="#default-28" 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-7">OIDC</span><span class="hl-1"> </span><span class="hl-4">auth</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">used</span>
|
|
358
366
|
</code><button type="button">Copy</button></pre>
|
|
359
367
|
|
|
360
368
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCovTokenSecret</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="commitgenerated"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>commit<wbr/>Generated</span><a href="#commitgenerated" 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">commitGenerated</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
361
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
369
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-29">Default<a href="#default-29" 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-5">true</span>
|
|
362
370
|
</code><button type="button">Copy</button></pre>
|
|
363
371
|
|
|
364
372
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.commitGenerated</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="constructsversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>constructs<wbr/>Version</span><a href="#constructsversion" 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">constructsVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Minimum version of the <code>constructs</code> library to depend on.</p>
|
|
365
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
373
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-30">Default<a href="#default-30" 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-4">for</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> 1.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-2">"3.2.27"</span><span class="hl-1">, </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> 2.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">is</span><br/><span class="hl-2">"10.5.1"</span><span class="hl-1">.</span>
|
|
366
374
|
</code><button type="button">Copy</button></pre>
|
|
367
375
|
|
|
368
376
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.constructsVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="context"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>context</span><a href="#context" 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">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Additional context to include in <code>cdk.json</code>.</p>
|
|
369
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
377
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-31">Default<a href="#default-31" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">additional</span><span class="hl-1"> </span><span class="hl-4">context</span>
|
|
370
378
|
</code><button type="button">Copy</button></pre>
|
|
371
379
|
|
|
372
380
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.context</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="copyrightowner"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>copyright<wbr/>Owner</span><a href="#copyrightowner" 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">copyrightOwner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>License copyright owner.</p>
|
|
373
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
381
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-32">Default<a href="#default-32" 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><ul>
|
|
374
382
|
<li>defaults to the value of authorName or "" if <code>authorName</code> is undefined.</li>
|
|
375
383
|
</ul>
|
|
376
384
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightOwner</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="copyrightperiod"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>copyright<wbr/>Period</span><a href="#copyrightperiod" 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">copyrightPeriod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The copyright years to put in the LICENSE file.</p>
|
|
377
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
385
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-33">Default<a href="#default-33" 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-4">current</span><span class="hl-1"> </span><span class="hl-4">year</span>
|
|
378
386
|
</code><button type="button">Copy</button></pre>
|
|
379
387
|
|
|
380
388
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightPeriod</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="defaultreleasebranch"><code class="tsd-tag">Readonly</code><span>default<wbr/>Release<wbr/>Branch</span><a href="#defaultreleasebranch" 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">defaultReleaseBranch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the main release branch.</p>
|
|
381
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
389
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-34">Default<a href="#default-34" 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">"main"</span>
|
|
390
|
+
</code><button type="button">Copy</button></pre>
|
|
391
|
+
|
|
392
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.defaultReleaseBranch</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="deleteorphanedlockfiles"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files</span><a href="#deleteorphanedlockfiles" 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">deleteOrphanedLockFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically delete lockfiles from package managers that are not the
|
|
393
|
+
active one. Only triggered when the lockfile for the configured package
|
|
394
|
+
manager already exists.</p>
|
|
395
|
+
<p>This is useful when migrating between package managers to avoid conflicts.</p>
|
|
396
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-35">Default<a href="#default-35" 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-5">true</span>
|
|
382
397
|
</code><button type="button">Copy</button></pre>
|
|
383
398
|
|
|
384
|
-
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.
|
|
399
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.deleteOrphanedLockFiles</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="dependabot"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dependabot</span><a href="#dependabot" 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">dependabot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use dependabot to handle dependency upgrades.
|
|
385
400
|
Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
386
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
401
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-36">Default<a href="#default-36" 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-5">false</span>
|
|
387
402
|
</code><button type="button">Copy</button></pre>
|
|
388
403
|
|
|
389
404
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabot</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="dependabotoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dependabot<wbr/>Options</span><a href="#dependabotoptions" 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">dependabotOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependabotOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
|
|
390
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
405
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-37">Default<a href="#default-37" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
391
406
|
</code><button type="button">Copy</button></pre>
|
|
392
407
|
|
|
393
408
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabotOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="deps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>deps</span><a href="#deps" 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">deps</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>Runtime dependencies of this module.</p>
|
|
394
409
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
395
|
-
<code>express</code>). This will behave similar to <code>
|
|
410
|
+
<code>express</code>). This will behave similar to <code>pnpm add</code> or <code>npm install</code> in the
|
|
396
411
|
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
397
412
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
398
|
-
the same syntax passed to <code>
|
|
399
|
-
this will be what
|
|
413
|
+
the same syntax passed to <code>pnpm add</code> or <code>npm i</code> (e.g. <code>express@^2</code>) and
|
|
414
|
+
this will be what your <code>package.json</code> will eventually include.</p>
|
|
400
415
|
</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-1">[ </span><span class="hl-2">'express'</span><span class="hl-1">, </span><span class="hl-2">'lodash'</span><span class="hl-1">, </span><span class="hl-2">'foo@^2'</span><span class="hl-1"> ]</span>
|
|
401
416
|
</code><button type="button">Copy</button></pre>
|
|
402
417
|
|
|
403
|
-
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
418
|
+
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-38">Default<a href="#default-38" 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>
|
|
404
419
|
</code><button type="button">Copy</button></pre>
|
|
405
420
|
|
|
406
421
|
</div><div class="tsd-tag-featured"><h4 class="tsd-anchor-link" id="featured">Featured<a href="#featured" 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></div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.deps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="depsupgrade"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>deps<wbr/>Upgrade</span><a href="#depsupgrade" 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">depsUpgrade</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use tasks and github workflows to handle dependency upgrades.
|
|
407
422
|
Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
408
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
423
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-39">Default<a href="#default-39" 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><ul>
|
|
409
424
|
<li><code>true</code> for root projects, <code>false</code> for subprojects</li>
|
|
410
425
|
</ul>
|
|
411
426
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgrade</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="depsupgradeoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>deps<wbr/>Upgrade<wbr/>Options</span><a href="#depsupgradeoptions" 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">depsUpgradeOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependenciesOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
|
|
412
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
427
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-40">Default<a href="#default-40" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
413
428
|
</code><button type="button">Copy</button></pre>
|
|
414
429
|
|
|
415
430
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgradeOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>description</span><a href="#description" 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">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The description is just a string that helps people understand the purpose of the package.
|
|
416
431
|
It can be used when searching for packages in a package manager as well.
|
|
417
432
|
See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-description">https://classic.yarnpkg.com/en/docs/package-json/#toc-description</a></p>
|
|
418
433
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-featured"><h4 class="tsd-anchor-link" id="featured-1">Featured<a href="#featured-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></div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.description</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="devcontainer"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dev<wbr/>Container</span><a href="#devcontainer" 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">devContainer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces)</p>
|
|
419
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
434
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-41">Default<a href="#default-41" 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-5">false</span>
|
|
420
435
|
</code><button type="button">Copy</button></pre>
|
|
421
436
|
|
|
422
437
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devContainer</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="devdeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dev<wbr/>Deps</span><a href="#devdeps" 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">devDeps</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>Build dependencies for this module. These dependencies will only be
|
|
423
438
|
available in your build environment but will not be fetched when this
|
|
424
439
|
module is consumed.</p>
|
|
425
440
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
426
|
-
<code>express</code>). This will behave similar to <code>
|
|
441
|
+
<code>express</code>). This will behave similar to <code>pnpm add</code> or <code>npm install</code> in the
|
|
427
442
|
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
428
443
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
429
|
-
the same syntax passed to <code>
|
|
430
|
-
this will be what
|
|
444
|
+
the same syntax passed to <code>pnpm add</code> or <code>npm i</code> (e.g. <code>express@^2</code>) and
|
|
445
|
+
this will be what your <code>package.json</code> will eventually include.</p>
|
|
431
446
|
</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-1">[ </span><span class="hl-2">'typescript'</span><span class="hl-1">, </span><span class="hl-2">'@types/express'</span><span class="hl-1"> ]</span>
|
|
432
447
|
</code><button type="button">Copy</button></pre>
|
|
433
448
|
|
|
434
|
-
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
449
|
+
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-42">Default<a href="#default-42" 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>
|
|
435
450
|
</code><button type="button">Copy</button></pre>
|
|
436
451
|
|
|
437
|
-
</div><div class="tsd-tag-featured"><h4 class="tsd-anchor-link" id="featured-2">Featured<a href="#featured-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></div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="
|
|
452
|
+
</div><div class="tsd-tag-featured"><h4 class="tsd-anchor-link" id="featured-2">Featured<a href="#featured-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></div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="devengines"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dev<wbr/>Engines</span><a href="#devengines" 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">devEngines</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DevEngines</span></div><div class="tsd-comment tsd-typography"><p>Configure the <code>devEngines</code> field in <code>package.json</code>.</p>
|
|
453
|
+
<p>The <code>devEngines.packageManager</code> field is automatically populated based on
|
|
454
|
+
the resolved <code>packageManager</code> value. Any fields provided here are merged
|
|
455
|
+
with the auto-populated <code>packageManager</code> entry.</p>
|
|
456
|
+
</div><div class="tsd-comment tsd-typography"><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.npmjs.com/cli/v10/configuring-npm/package-json#devengines">https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines</a></p>
|
|
457
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devEngines</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="disabletsconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>disable<wbr/>Tsconfig</span><a href="#disabletsconfig" 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">disableTsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.json</code> file (used by jsii projects since
|
|
438
458
|
tsconfig.json is generated by the jsii compiler).</p>
|
|
439
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
459
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-43">Default<a href="#default-43" 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-5">false</span>
|
|
440
460
|
</code><button type="button">Copy</button></pre>
|
|
441
461
|
|
|
442
462
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfig</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="disabletsconfigdev"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>disable<wbr/>Tsconfig<wbr/>Dev</span><a href="#disabletsconfigdev" 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">disableTsconfigDev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.dev.json</code> file.</p>
|
|
443
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
463
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-44">Default<a href="#default-44" 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-5">false</span>
|
|
444
464
|
</code><button type="button">Copy</button></pre>
|
|
445
465
|
|
|
446
466
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfigDev</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="docgen"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>docgen</span><a href="#docgen" 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">docgen</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Docgen by Typedoc</p>
|
|
447
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
467
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-45">Default<a href="#default-45" 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-5">false</span>
|
|
448
468
|
</code><button type="button">Copy</button></pre>
|
|
449
469
|
|
|
450
470
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docgen</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="docsdirectory"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>docs<wbr/>Directory</span><a href="#docsdirectory" 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">docsDirectory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Docs directory</p>
|
|
451
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
471
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-46">Default<a href="#default-46" 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">"docs"</span>
|
|
452
472
|
</code><button type="button">Copy</button></pre>
|
|
453
473
|
|
|
454
474
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docsDirectory</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="edgelambdaautodiscover"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><a href="#edgelambdaautodiscover" 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">edgeLambdaAutoDiscover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically adds an <code>cloudfront.experimental.EdgeFunction</code> for each
|
|
455
475
|
<code>.edge-lambda.ts</code> handler in your source tree. If this is disabled, you can
|
|
456
476
|
manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
457
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
477
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-47">Default<a href="#default-47" 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-5">true</span>
|
|
458
478
|
</code><button type="button">Copy</button></pre>
|
|
459
479
|
|
|
460
480
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.edgeLambdaAutoDiscover</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="entrypoint"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>entrypoint</span><a href="#entrypoint" 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">entrypoint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Module entrypoint (<code>main</code> in <code>package.json</code>)</p>
|
|
461
481
|
<p>Set to an empty string to not include <code>main</code> in your package.json</p>
|
|
462
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
482
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-48">Default<a href="#default-48" 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">"lib/index.js"</span>
|
|
463
483
|
</code><button type="button">Copy</button></pre>
|
|
464
484
|
|
|
465
485
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypoint</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="entrypointtypes"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>entrypoint<wbr/>Types</span><a href="#entrypointtypes" 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">entrypointTypes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
|
|
466
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
486
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-49">Default<a href="#default-49" 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-4">d</span><span class="hl-1">.</span><span class="hl-4">ts</span><span class="hl-1"> </span><span class="hl-4">file</span><span class="hl-1"> </span><span class="hl-4">derived</span><span class="hl-1"> </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-2">'s entrypoint (usually lib/index.d.ts</span><span class="hl-9">)</span>
|
|
467
487
|
</code><button type="button">Copy</button></pre>
|
|
468
488
|
|
|
469
489
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypointTypes</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="eslint"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>eslint</span><a href="#eslint" 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">eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Setup eslint.</p>
|
|
470
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
490
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-50">Default<a href="#default-50" 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">true</span><span class="hl-1">, </span><span class="hl-4">unless</span><span class="hl-1"> </span><span class="hl-4">biome</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">enabled</span>
|
|
471
491
|
</code><button type="button">Copy</button></pre>
|
|
472
492
|
|
|
473
493
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslint</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="eslintoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>eslint<wbr/>Options</span><a href="#eslintoptions" 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">eslintOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">EslintOptions</span></div><div class="tsd-comment tsd-typography"><p>Eslint options</p>
|
|
474
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
494
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-51">Default<a href="#default-51" 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-4">opinionated</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
475
495
|
</code><button type="button">Copy</button></pre>
|
|
476
496
|
|
|
477
497
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslintOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="experimentalintegrunner"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code> <code class="tsd-tag">Experimental</code><span>experimental<wbr/>Integ<wbr/>Runner</span><a href="#experimentalintegrunner" 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">experimentalIntegRunner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable experimental support for the AWS CDK integ-runner.</p>
|
|
478
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
498
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-52">Default<a href="#default-52" 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-5">false</span><br/><span class="hl-1">@</span><span class="hl-4">experimental</span>
|
|
479
499
|
</code><button type="button">Copy</button></pre>
|
|
480
500
|
|
|
481
501
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.experimentalIntegRunner</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="featureflags"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>feature<wbr/>Flags</span><a href="#featureflags" 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">featureFlags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ICdkFeatureFlags</span></div><div class="tsd-comment tsd-typography"><p>Feature flags that should be enabled in <code>cdk.json</code>.</p>
|
|
482
502
|
<p>Make sure to double-check any changes to feature flags in <code>cdk.json</code> before deploying.
|
|
483
503
|
Unexpected changes may cause breaking changes in your CDK app.
|
|
484
504
|
You can overwrite any feature flag by passing it into the context field.</p>
|
|
485
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
505
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-53">Default<a href="#default-53" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">feature</span><span class="hl-1"> </span><span class="hl-4">flags</span><span class="hl-1"> </span><span class="hl-4">are</span><span class="hl-1"> </span><span class="hl-4">enabled</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-3">default</span>
|
|
486
506
|
</code><button type="button">Copy</button></pre>
|
|
487
507
|
|
|
488
508
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.featureFlags</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="github"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>github</span><a href="#github" 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">github</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable GitHub integration.</p>
|
|
489
509
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
490
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
510
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-54">Default<a href="#default-54" 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-5">true</span>
|
|
491
511
|
</code><button type="button">Copy</button></pre>
|
|
492
512
|
|
|
493
513
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.github</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="githuboptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>github<wbr/>Options</span><a href="#githuboptions" 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">githubOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitHubOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for GitHub integration</p>
|
|
494
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
514
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-55">Default<a href="#default-55" 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-4">see</span><span class="hl-1"> </span><span class="hl-4">GitHubOptions</span>
|
|
495
515
|
</code><button type="button">Copy</button></pre>
|
|
496
516
|
|
|
497
517
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.githubOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="gitignore"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>gitignore</span><a href="#gitignore" 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">gitignore</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>Additional entries to .gitignore</p>
|
|
498
518
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitignore</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="gitignoreoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>git<wbr/>Ignore<wbr/>Options</span><a href="#gitignoreoptions" 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">gitIgnoreOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span></div><div class="tsd-comment tsd-typography"><p>Configuration options for .gitignore file</p>
|
|
499
519
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitIgnoreOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="gitoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>git<wbr/>Options</span><a href="#gitoptions" 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">gitOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitOptions</span></div><div class="tsd-comment tsd-typography"><p>Configuration options for git</p>
|
|
500
520
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="gitpod"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>gitpod</span><a href="#gitpod" 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">gitpod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment</p>
|
|
501
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
521
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-56">Default<a href="#default-56" 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-5">false</span>
|
|
502
522
|
</code><button type="button">Copy</button></pre>
|
|
503
523
|
|
|
504
524
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitpod</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="homepage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>homepage</span><a href="#homepage" 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">homepage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Package's Homepage / Website</p>
|
|
505
525
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.homepage</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="integrationtestautodiscover"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span><a href="#integrationtestautodiscover" 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">integrationTestAutoDiscover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically discovers and creates integration tests for each <code>.integ.ts</code>
|
|
506
526
|
file in under your test directory.</p>
|
|
507
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
527
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-57">Default<a href="#default-57" 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-5">true</span>
|
|
508
528
|
</code><button type="button">Copy</button></pre>
|
|
509
529
|
|
|
510
530
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.integrationTestAutoDiscover</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="jest"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>jest</span><a href="#jest" 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">jest</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Setup jest unit tests</p>
|
|
511
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
531
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-58">Default<a href="#default-58" 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-5">true</span>
|
|
512
532
|
</code><button type="button">Copy</button></pre>
|
|
513
533
|
|
|
514
534
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jest</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="jestoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>jest<wbr/>Options</span><a href="#jestoptions" 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">jestOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JestOptions</span></div><div class="tsd-comment tsd-typography"><p>Jest options</p>
|
|
515
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
535
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-59">Default<a href="#default-59" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
516
536
|
</code><button type="button">Copy</button></pre>
|
|
517
537
|
|
|
518
538
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jestOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="jsiireleaseversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>jsii<wbr/>Release<wbr/>Version</span><a href="#jsiireleaseversion" 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">jsiiReleaseVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
519
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
539
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-60">Default<a href="#default-60" 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">"latest"</span>
|
|
520
540
|
</code><button type="button">Copy</button></pre>
|
|
521
541
|
|
|
522
542
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jsiiReleaseVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="keywords"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>keywords</span><a href="#keywords" 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">keywords</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>Keywords to include in <code>package.json</code>.</p>
|
|
523
543
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.keywords</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="lambdaautodiscover"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>lambda<wbr/>Auto<wbr/>Discover</span><a href="#lambdaautodiscover" 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">lambdaAutoDiscover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaFunction</code> for each <code>.lambda.ts</code> handler
|
|
524
544
|
in your source tree. If this is disabled, you can manually add an
|
|
525
545
|
<code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
526
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
546
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-61">Default<a href="#default-61" 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-5">true</span>
|
|
527
547
|
</code><button type="button">Copy</button></pre>
|
|
528
548
|
|
|
529
549
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaAutoDiscover</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="lambdaextensionautodiscover"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span><a href="#lambdaextensionautodiscover" 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">lambdaExtensionAutoDiscover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaExtension</code> for each <code>.lambda-extension.ts</code>
|
|
530
550
|
entrypoint in your source tree. If this is disabled, you can manually add an
|
|
531
551
|
<code>awscdk.AutoDiscover</code> component to your project</p>
|
|
532
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
552
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-62">Default<a href="#default-62" 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-5">true</span>
|
|
533
553
|
</code><button type="button">Copy</button></pre>
|
|
534
554
|
|
|
535
555
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaExtensionAutoDiscover</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="lambdaoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>lambda<wbr/>Options</span><a href="#lambdaoptions" 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">lambdaOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LambdaFunctionCommonOptions</span></div><div class="tsd-comment tsd-typography"><p>Common options for all AWS Lambda functions.</p>
|
|
536
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
556
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-63">Default<a href="#default-63" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
537
557
|
</code><button type="button">Copy</button></pre>
|
|
538
558
|
|
|
539
559
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="libdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>libdir</span><a href="#libdir" 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">libdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory</p>
|
|
540
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
560
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-64">Default<a href="#default-64" 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">"lib"</span>
|
|
541
561
|
</code><button type="button">Copy</button></pre>
|
|
542
562
|
|
|
543
563
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.libdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="license"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>license</span><a href="#license" 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">license</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>License's SPDX identifier.
|
|
544
564
|
See <a href="https://github.com/projen/projen/tree/main/license-text">https://github.com/projen/projen/tree/main/license-text</a> for a list of supported licenses.
|
|
545
565
|
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
546
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
566
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-65">Default<a href="#default-65" 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">"Apache-2.0"</span>
|
|
547
567
|
</code><button type="button">Copy</button></pre>
|
|
548
568
|
|
|
549
569
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.license</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="licensed"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>licensed</span><a href="#licensed" 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">licensed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
550
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
570
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-66">Default<a href="#default-66" 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-5">true</span>
|
|
551
571
|
</code><button type="button">Copy</button></pre>
|
|
552
572
|
|
|
553
573
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.licensed</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="logging"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>logging</span><a href="#logging" 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">logging</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoggerOptions</span></div><div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
554
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
574
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-67">Default<a href="#default-67" 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>
|
|
555
575
|
</code><button type="button">Copy</button></pre>
|
|
556
576
|
|
|
557
577
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.logging</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="majorversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>major<wbr/>Version</span><a href="#majorversion" 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">majorVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Major version to release from the default branch.</p>
|
|
558
578
|
<p>If this is specified, we bump the latest version of this major version line.
|
|
559
579
|
If not specified, we bump the global latest version.</p>
|
|
560
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
580
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-68">Default<a href="#default-68" 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-4">Major</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">enforced</span><span class="hl-1">.</span>
|
|
561
581
|
</code><button type="button">Copy</button></pre>
|
|
562
582
|
|
|
563
583
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.majorVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="maxnodeversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>max<wbr/>Node<wbr/>Version</span><a href="#maxnodeversion" 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">maxNodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The maximum node version supported by this package.
|
|
@@ -566,16 +586,16 @@ Most projects should not use this option.</p>
|
|
|
566
586
|
This requirement is enforced via the engines field.</p>
|
|
567
587
|
<p>You will normally not need to set this option.
|
|
568
588
|
Consider this option only if your package is known to not function with newer versions of node.</p>
|
|
569
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
589
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-69">Default<a href="#default-69" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">maximum</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">enforced</span>
|
|
570
590
|
</code><button type="button">Copy</button></pre>
|
|
571
591
|
|
|
572
592
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.maxNodeVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="mergify"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">mergify</span><a href="#mergify" 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">mergify</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether mergify should be enabled on this repository or not.</p>
|
|
573
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
593
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-70">Default<a href="#default-70" 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-5">true</span>
|
|
574
594
|
</code><button type="button">Copy</button></pre>
|
|
575
595
|
|
|
576
596
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-5">Deprecated<a href="#deprecated-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><p>use <code>githubOptions.mergify</code> instead</p>
|
|
577
597
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergify</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="mergifyoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">mergify<wbr/>Options</span><a href="#mergifyoptions" 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">mergifyOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MergifyOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for mergify</p>
|
|
578
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
598
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-71">Default<a href="#default-71" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
579
599
|
</code><button type="button">Copy</button></pre>
|
|
580
600
|
|
|
581
601
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-6">Deprecated<a href="#deprecated-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><p>use <code>githubOptions.mergifyOptions</code> instead</p>
|
|
@@ -583,7 +603,7 @@ Consider this option only if your package is known to not function with newer ve
|
|
|
583
603
|
<p>This can be useful to set to 1, as breaking changes before the 1.x major
|
|
584
604
|
release are not incrementing the major version number.</p>
|
|
585
605
|
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
586
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
606
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-72">Default<a href="#default-72" 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-4">No</span><span class="hl-1"> </span><span class="hl-4">minimum</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">being</span><span class="hl-1"> </span><span class="hl-4">enforced</span>
|
|
587
607
|
</code><button type="button">Copy</button></pre>
|
|
588
608
|
|
|
589
609
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minMajorVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="minnodeversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>min<wbr/>Node<wbr/>Version</span><a href="#minnodeversion" 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">minNodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The minimum node version required by this package to function.
|
|
@@ -595,21 +615,21 @@ Consider this option only if your package depends on a specific feature, that is
|
|
|
595
615
|
Setting this option has very high impact on the consumers of your package,
|
|
596
616
|
as package managers will actively prevent usage with node versions you have marked as incompatible.</p>
|
|
597
617
|
<p>To change the node version of your CI/CD workflows, use <code>workflowNodeVersion</code>.</p>
|
|
598
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
618
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-73">Default<a href="#default-73" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">minimum</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">enforced</span>
|
|
599
619
|
</code><button type="button">Copy</button></pre>
|
|
600
620
|
|
|
601
621
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minNodeVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="mutablebuild"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">mutable<wbr/>Build</span><a href="#mutablebuild" 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">mutableBuild</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically update files modified during builds to pull-request branches. This means
|
|
602
622
|
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
603
623
|
before a PR is merged.</p>
|
|
604
624
|
<p>Implies that PR builds do not have anti-tamper checks.</p>
|
|
605
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
625
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-74">Default<a href="#default-74" 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-5">true</span>
|
|
606
626
|
</code><button type="button">Copy</button></pre>
|
|
607
627
|
|
|
608
628
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-7">Deprecated<a href="#deprecated-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><ul>
|
|
609
629
|
<li>Use <code>buildWorkflowOptions.mutableBuild</code></li>
|
|
610
630
|
</ul>
|
|
611
631
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mutableBuild</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="name"><code class="tsd-tag">Readonly</code><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
612
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
632
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-75">Default<a href="#default-75" 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-4">$BASEDIR</span>
|
|
613
633
|
</code><button type="button">Copy</button></pre>
|
|
614
634
|
|
|
615
635
|
</div><div class="tsd-tag-featured"><h4 class="tsd-anchor-link" id="featured-3">Featured<a href="#featured-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></div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="nextversioncommand"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>next<wbr/>Version<wbr/>Command</span><a href="#nextversioncommand" 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">nextVersionCommand</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A shell command to control the next version to release.</p>
|
|
@@ -631,11 +651,11 @@ with the indicated component bumped.</li>
|
|
|
631
651
|
</ul>
|
|
632
652
|
<p>This setting cannot be specified together with <code>minMajorVersion</code>; the invoked
|
|
633
653
|
script can be used to achieve the effects of <code>minMajorVersion</code>.</p>
|
|
634
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
654
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-76">Default<a href="#default-76" 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-4">The</span><span class="hl-1"> </span><span class="hl-4">next</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">determined</span><span class="hl-1"> </span><span class="hl-4">based</span><span class="hl-1"> </span><span class="hl-4">on</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">commit</span><span class="hl-1"> </span><span class="hl-4">history</span><span class="hl-1"> </span><span class="hl-4">and</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-1"> </span><span class="hl-4">settings</span><span class="hl-1">.</span>
|
|
635
655
|
</code><button type="button">Copy</button></pre>
|
|
636
656
|
|
|
637
657
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.nextVersionCommand</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmaccess"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Access</span><a href="#npmaccess" 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">npmAccess</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NpmAccess</span></div><div class="tsd-comment tsd-typography"><p>Access level of the npm package.</p>
|
|
638
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
658
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-77">Default<a href="#default-77" 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><ul>
|
|
639
659
|
<li>for scoped packages (e.g. <code>foo@bar</code>), the default is
|
|
640
660
|
<code>NpmAccess.RESTRICTED</code>, for non-scoped packages, the default is
|
|
641
661
|
<code>NpmAccess.PUBLIC</code>.</li>
|
|
@@ -643,7 +663,7 @@ script can be used to achieve the effects of <code>minMajorVersion</code>.</p>
|
|
|
643
663
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmAccess</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmdisttag"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Dist<wbr/>Tag</span><a href="#npmdisttag" 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">npmDistTag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The npmDistTag to use when publishing from the default branch.</p>
|
|
644
664
|
<p>To set the npm dist-tag for release branches, set the <code>npmDistTag</code> property
|
|
645
665
|
for each branch.</p>
|
|
646
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
666
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-78">Default<a href="#default-78" 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">"latest"</span>
|
|
647
667
|
</code><button type="button">Copy</button></pre>
|
|
648
668
|
|
|
649
669
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmDistTag</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmignore"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">npmignore</span><a href="#npmignore" 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">npmignore</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>Additional entries to .npmignore.</p>
|
|
@@ -652,7 +672,7 @@ for each branch.</p>
|
|
|
652
672
|
</ul>
|
|
653
673
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignore</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmignoreenabled"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npmignore<wbr/>Enabled</span><a href="#npmignoreenabled" 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">npmignoreEnabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines an .npmignore file. Normally this is only needed for libraries that
|
|
654
674
|
are packaged as tarballs.</p>
|
|
655
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
675
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-79">Default<a href="#default-79" 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-5">true</span>
|
|
656
676
|
</code><button type="button">Copy</button></pre>
|
|
657
677
|
|
|
658
678
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignoreEnabled</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmignoreoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Ignore<wbr/>Options</span><a href="#npmignoreoptions" 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">npmIgnoreOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span></div><div class="tsd-comment tsd-typography"><p>Configuration options for .npmignore file</p>
|
|
@@ -661,24 +681,24 @@ are packaged as tarballs.</p>
|
|
|
661
681
|
you will need to use a supported CI/CD provider.</p>
|
|
662
682
|
<p>Note that the projen <code>Release</code> and <code>Publisher</code> components are using <code>publib</code> to publish packages,
|
|
663
683
|
which is using npm internally and supports provenance statements independently of the package manager used.</p>
|
|
664
|
-
</div><div class="tsd-comment tsd-typography"><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.npmjs.com/generating-provenance-statements">https://docs.npmjs.com/generating-provenance-statements</a></p>
|
|
665
|
-
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
684
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-1">See<a href="#see-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><p><a href="https://docs.npmjs.com/generating-provenance-statements">https://docs.npmjs.com/generating-provenance-statements</a></p>
|
|
685
|
+
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-80">Default<a href="#default-80" 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">true</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">packages</span><span class="hl-1">, </span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-4">otherwise</span>
|
|
666
686
|
</code><button type="button">Copy</button></pre>
|
|
667
687
|
|
|
668
688
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmProvenance</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmregistry"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">npm<wbr/>Registry</span><a href="#npmregistry" 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">npmRegistry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The host name of the npm registry to publish to. Cannot be set together with <code>npmRegistryUrl</code>.</p>
|
|
669
689
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-9">Deprecated<a href="#deprecated-9" 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>use <code>npmRegistryUrl</code> instead</p>
|
|
670
690
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistry</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmregistryurl"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Registry<wbr/>Url</span><a href="#npmregistryurl" 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">npmRegistryUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The base URL of the npm package registry.</p>
|
|
671
691
|
<p>Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
672
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
692
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-81">Default<a href="#default-81" 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">"https://registry.npmjs.org"</span>
|
|
673
693
|
</code><button type="button">Copy</button></pre>
|
|
674
694
|
|
|
675
695
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistryUrl</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmtokensecret"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Token<wbr/>Secret</span><a href="#npmtokensecret" 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">npmTokenSecret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
676
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
696
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-82">Default<a href="#default-82" 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">"NPM_TOKEN"</span>
|
|
677
697
|
</code><button type="button">Copy</button></pre>
|
|
678
698
|
|
|
679
699
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmTokenSecret</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="npmtrustedpublishing"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Trusted<wbr/>Publishing</span><a href="#npmtrustedpublishing" 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">npmTrustedPublishing</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use trusted publishing for publishing to <a href="http://npmjs.com">npmjs.com</a>
|
|
680
700
|
Needs to be pre-configured on npm.js to work.</p>
|
|
681
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-
|
|
701
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-2">See<a href="#see-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></div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-83">Default<a href="#default-83" 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">false</span>
|
|
682
702
|
</code><button type="button">Copy</button></pre>
|
|
683
703
|
|
|
684
704
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmTrustedPublishing</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="outdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>outdir</span><a href="#outdir" 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">outdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The root directory of the project.</p>
|
|
@@ -686,20 +706,21 @@ Needs to be pre-configured on npm.js to work.</p>
|
|
|
686
706
|
<p>If this project has a parent, this directory is relative to the parent
|
|
687
707
|
directory and it cannot be the same as the parent or any of it's other
|
|
688
708
|
subprojects.</p>
|
|
689
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
709
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-84">Default<a href="#default-84" 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">"."</span>
|
|
690
710
|
</code><button type="button">Copy</button></pre>
|
|
691
711
|
|
|
692
712
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.outdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="package"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package</span><a href="#package" 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">package</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines a <code>package</code> task that will produce an npm tarball under the
|
|
693
713
|
artifacts directory (e.g. <code>dist</code>).</p>
|
|
694
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
714
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-85">Default<a href="#default-85" 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-5">true</span>
|
|
695
715
|
</code><button type="button">Copy</button></pre>
|
|
696
716
|
|
|
697
717
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.package</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="packagemanager"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package<wbr/>Manager</span><a href="#packagemanager" 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">packageManager</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NodePackageManager</span></div><div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts</p>
|
|
698
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
699
|
-
</code
|
|
700
|
-
|
|
718
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-86">Default<a href="#default-86" 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><ul>
|
|
719
|
+
<li>Detected from the calling process or <code>YARN_CLASSIC</code> if detection fails.</li>
|
|
720
|
+
</ul>
|
|
721
|
+
</div><div class="tsd-tag-pjnew"><h4 class="tsd-anchor-link" id="pjnew">Pjnew<a href="#pjnew" 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>$PACKAGE_MANAGER</p>
|
|
701
722
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageManager</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="packagename"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package<wbr/>Name</span><a href="#packagename" 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">packageName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The "name" in package.json</p>
|
|
702
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
723
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-87">Default<a href="#default-87" 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-4">defaults</span><span class="hl-1"> </span><span class="hl-4">to</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-1"> </span><span class="hl-4">name</span>
|
|
703
724
|
</code><button type="button">Copy</button></pre>
|
|
704
725
|
|
|
705
726
|
</div><div class="tsd-tag-featured"><h4 class="tsd-anchor-link" id="featured-4">Featured<a href="#featured-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></div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageName</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="parent"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>parent</span><a href="#parent" 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">parent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span></div><div class="tsd-comment tsd-typography"><p>The parent project, if this project is part of a bigger project.</p>
|
|
@@ -715,110 +736,110 @@ breaking change for your customers.</p>
|
|
|
715
736
|
enabled by default), projen will automatically add a dev dependency with a
|
|
716
737
|
pinned version for each peer dependency. This will ensure that you build &
|
|
717
738
|
test your module against the lowest peer version required.</p>
|
|
718
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
739
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-88">Default<a href="#default-88" 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>
|
|
719
740
|
</code><button type="button">Copy</button></pre>
|
|
720
741
|
|
|
721
742
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="pnpmversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pnpm<wbr/>Version</span><a href="#pnpmversion" 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">pnpmVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
722
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
743
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-89">Default<a href="#default-89" 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">"10.33.0"</span>
|
|
723
744
|
</code><button type="button">Copy</button></pre>
|
|
724
745
|
|
|
725
746
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pnpmVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="postbuildsteps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>post<wbr/>Build<wbr/>Steps</span><a href="#postbuildsteps" 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">postBuildSteps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
726
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
747
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-90">Default<a href="#default-90" 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>
|
|
727
748
|
</code><button type="button">Copy</button></pre>
|
|
728
749
|
|
|
729
750
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.postBuildSteps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="prerelease"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>prerelease</span><a href="#prerelease" 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">prerelease</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Bump versions from the default branch as pre-releases (e.g. "beta",
|
|
730
751
|
"alpha", "pre").</p>
|
|
731
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
752
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-91">Default<a href="#default-91" 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-4">normal</span><span class="hl-1"> </span><span class="hl-4">semantic</span><span class="hl-1"> </span><span class="hl-4">versions</span>
|
|
732
753
|
</code><button type="button">Copy</button></pre>
|
|
733
754
|
|
|
734
755
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prerelease</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="prettier"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>prettier</span><a href="#prettier" 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">prettier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Setup prettier.</p>
|
|
735
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
756
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-92">Default<a href="#default-92" 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-5">false</span>
|
|
736
757
|
</code><button type="button">Copy</button></pre>
|
|
737
758
|
|
|
738
759
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettier</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="prettieroptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>prettier<wbr/>Options</span><a href="#prettieroptions" 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">prettierOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PrettierOptions</span></div><div class="tsd-comment tsd-typography"><p>Prettier options</p>
|
|
739
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
760
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-93">Default<a href="#default-93" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
740
761
|
</code><button type="button">Copy</button></pre>
|
|
741
762
|
|
|
742
763
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettierOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projecttree"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>project<wbr/>Tree</span><a href="#projecttree" 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">projectTree</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate a project tree file (<code>.projen/tree.json</code>) that shows all
|
|
743
764
|
components and their relationships. Useful for understanding your
|
|
744
765
|
project structure and debugging.</p>
|
|
745
766
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-1">Stability<a href="#stability-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><p>experimental</p>
|
|
746
|
-
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
767
|
+
</div><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-94">Default<a href="#default-94" 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-5">false</span>
|
|
747
768
|
</code><button type="button">Copy</button></pre>
|
|
748
769
|
|
|
749
770
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projectTree</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projecttype"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">project<wbr/>Type</span><a href="#projecttype" 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">projectType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjectType</span></div><div class="tsd-comment tsd-typography"><p>Which type of project this is (library/app).</p>
|
|
750
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
771
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-95">Default<a href="#default-95" 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-4">ProjectType</span><span class="hl-1">.</span><span class="hl-7">UNKNOWN</span>
|
|
751
772
|
</code><button type="button">Copy</button></pre>
|
|
752
773
|
|
|
753
774
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-10">Deprecated<a href="#deprecated-10" 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>no longer supported at the base project level</p>
|
|
754
775
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projectType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projencommand"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Command</span><a href="#projencommand" 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">projenCommand</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The shell command to use in order to run the projen CLI.</p>
|
|
755
776
|
<p>Can be used to customize in special environments.</p>
|
|
756
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
777
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-96">Default<a href="#default-96" 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">"npx projen"</span>
|
|
757
778
|
</code><button type="button">Copy</button></pre>
|
|
758
779
|
|
|
759
780
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCommand</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projencredentials"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Credentials</span><a href="#projencredentials" 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">projenCredentials</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GithubCredentials</span></div><div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
760
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
781
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-97">Default<a href="#default-97" 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-4">use</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">personal</span><span class="hl-1"> </span><span class="hl-4">access</span><span class="hl-1"> </span><span class="hl-4">token</span><span class="hl-1"> </span><span class="hl-4">named</span><span class="hl-1"> </span><span class="hl-7">PROJEN_GITHUB_TOKEN</span>
|
|
761
782
|
</code><button type="button">Copy</button></pre>
|
|
762
783
|
|
|
763
784
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCredentials</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projendevdependency"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Dev<wbr/>Dependency</span><a href="#projendevdependency" 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">projenDevDependency</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
764
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
785
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-98">Default<a href="#default-98" 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">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
|
|
765
786
|
</code><button type="button">Copy</button></pre>
|
|
766
787
|
|
|
767
788
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenDevDependency</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenrcjs"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Js</span><a href="#projenrcjs" 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">projenrcJs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.js (in JavaScript). Set to <code>false</code> in order to disable
|
|
768
789
|
.projenrc.js generation.</p>
|
|
769
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
790
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-99">Default<a href="#default-99" 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">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">projenrcJson</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-5">false</span>
|
|
770
791
|
</code><button type="button">Copy</button></pre>
|
|
771
792
|
|
|
772
793
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenrcjson"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Json</span><a href="#projenrcjson" 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">projenrcJson</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.json (in JSON). Set to <code>false</code> in order to disable
|
|
773
794
|
.projenrc.json generation.</p>
|
|
774
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
795
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-100">Default<a href="#default-100" 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-5">false</span>
|
|
775
796
|
</code><button type="button">Copy</button></pre>
|
|
776
797
|
|
|
777
798
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJson</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenrcjsonoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Json<wbr/>Options</span><a href="#projenrcjsonoptions" 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">projenrcJsonOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcJsonOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for .projenrc.json</p>
|
|
778
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
799
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-101">Default<a href="#default-101" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
779
800
|
</code><button type="button">Copy</button></pre>
|
|
780
801
|
|
|
781
802
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsonOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenrcjsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Js<wbr/>Options</span><a href="#projenrcjsoptions" 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">projenrcJsOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for .projenrc.js</p>
|
|
782
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
803
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-102">Default<a href="#default-102" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
783
804
|
</code><button type="button">Copy</button></pre>
|
|
784
805
|
|
|
785
806
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenrcts"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Ts</span><a href="#projenrcts" 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">projenrcTs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
786
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
807
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-103">Default<a href="#default-103" 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-5">false</span>
|
|
787
808
|
</code><button type="button">Copy</button></pre>
|
|
788
809
|
|
|
789
|
-
</div><div class="tsd-tag-pjnew"><h4 class="tsd-anchor-link" id="pjnew">Pjnew<a href="#pjnew" 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>true</p>
|
|
810
|
+
</div><div class="tsd-tag-pjnew"><h4 class="tsd-anchor-link" id="pjnew-1">Pjnew<a href="#pjnew-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><p>true</p>
|
|
790
811
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenrctsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrctsoptions" 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">projenrcTsOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for .projenrc.ts</p>
|
|
791
812
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTsOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projentokensecret"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">projen<wbr/>Token<wbr/>Secret</span><a href="#projentokensecret" 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">projenTokenSecret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of a secret which includes a GitHub Personal Access Token to be
|
|
792
813
|
used by projen workflows. This token needs to have the <code>repo</code>, <code>workflows</code>
|
|
793
814
|
and <code>packages</code> scope.</p>
|
|
794
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
815
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-104">Default<a href="#default-104" 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">"PROJEN_GITHUB_TOKEN"</span>
|
|
795
816
|
</code><button type="button">Copy</button></pre>
|
|
796
817
|
|
|
797
818
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-11">Deprecated<a href="#deprecated-11" 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>use <code>projenCredentials</code></p>
|
|
798
819
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenTokenSecret</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="projenversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Version</span><a href="#projenversion" 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">projenVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
799
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
820
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-105">Default<a href="#default-105" 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-4">Defaults</span><span class="hl-1"> </span><span class="hl-4">to</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">latest</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1">.</span>
|
|
800
821
|
</code><button type="button">Copy</button></pre>
|
|
801
822
|
|
|
802
823
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="publishdryrun"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>Dry<wbr/>Run</span><a href="#publishdryrun" 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">publishDryRun</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
803
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
824
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-106">Default<a href="#default-106" 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-5">false</span>
|
|
804
825
|
</code><button type="button">Copy</button></pre>
|
|
805
826
|
|
|
806
827
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishDryRun</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="publishtasks"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>Tasks</span><a href="#publishtasks" 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">publishTasks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Define publishing tasks that can be executed manually as well as workflows.</p>
|
|
807
828
|
<p>Normally, publishing only happens within automated workflows. Enable this
|
|
808
829
|
in order to create a publishing task for each publishing activity.</p>
|
|
809
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
830
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-107">Default<a href="#default-107" 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-5">false</span>
|
|
810
831
|
</code><button type="button">Copy</button></pre>
|
|
811
832
|
|
|
812
833
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishTasks</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="pullrequesttemplate"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pull<wbr/>Request<wbr/>Template</span><a href="#pullrequesttemplate" 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">pullRequestTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
813
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
834
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-108">Default<a href="#default-108" 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-5">true</span>
|
|
814
835
|
</code><button type="button">Copy</button></pre>
|
|
815
836
|
|
|
816
837
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplate</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="pullrequesttemplatecontents"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><a href="#pullrequesttemplatecontents" 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">pullRequestTemplateContents</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>The contents of the pull request template.</p>
|
|
817
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
838
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-109">Default<a href="#default-109" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">content</span>
|
|
818
839
|
</code><button type="button">Copy</button></pre>
|
|
819
840
|
|
|
820
841
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplateContents</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="readme"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>readme</span><a href="#readme" 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">readme</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SampleReadmeProps</span></div><div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
821
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
842
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-110">Default<a href="#default-110" 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-10">filename</span><span class="hl-1">: </span><span class="hl-2">'README.md'</span><span class="hl-1">, </span><span class="hl-10">contents</span><span class="hl-1">: </span><span class="hl-2">'# replace this'</span><span class="hl-1"> }</span>
|
|
822
843
|
</code><button type="button">Copy</button></pre>
|
|
823
844
|
|
|
824
845
|
</div><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">"{ filename: 'readme.md', contents: '# title' }"</span>
|
|
@@ -826,11 +847,11 @@ in order to create a publishing task for each publishing activity.</p>
|
|
|
826
847
|
|
|
827
848
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.readme</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releasablecommits"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>releasable<wbr/>Commits</span><a href="#releasablecommits" 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">releasableCommits</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleasableCommits</span></div><div class="tsd-comment tsd-typography"><p>Find commits that should be considered releasable
|
|
828
849
|
Used to decide if a release is required.</p>
|
|
829
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
850
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-111">Default<a href="#default-111" 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-4">ReleasableCommits</span><span class="hl-1">.</span><span class="hl-0">everyCommit</span><span class="hl-1">()</span>
|
|
830
851
|
</code><button type="button">Copy</button></pre>
|
|
831
852
|
|
|
832
853
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releasableCommits</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="release"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release</span><a href="#release" 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">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
833
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
854
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-112">Default<a href="#default-112" 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">true</span><span class="hl-1"> (</span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span><span class="hl-1">)</span>
|
|
834
855
|
</code><button type="button">Copy</button></pre>
|
|
835
856
|
|
|
836
857
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.release</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releasebranches"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Branches</span><a href="#releasebranches" 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">releaseBranches</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">BranchOptions</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Defines additional release branches. A workflow will be created for each
|
|
@@ -839,7 +860,7 @@ Each release branch <em>must</em> be assigned a major version number which is us
|
|
|
839
860
|
to enforce that versions published from that branch always use that major
|
|
840
861
|
version. If multiple branches are used, the <code>majorVersion</code> field must also
|
|
841
862
|
be provided for the default branch.</p>
|
|
842
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
863
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-113">Default<a href="#default-113" 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><ul>
|
|
843
864
|
<li>no additional branches are used for release. you can use
|
|
844
865
|
<code>addBranch()</code> to add additional branches.</li>
|
|
845
866
|
</ul>
|
|
@@ -848,25 +869,25 @@ be provided for the default branch.</p>
|
|
|
848
869
|
or limit who can initiate a release through environment protection rules.</p>
|
|
849
870
|
<p>When multiple artifacts are released, the environment can be overwritten
|
|
850
871
|
on a per artifact basis.</p>
|
|
851
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
872
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-114">Default<a href="#default-114" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">environment</span><span class="hl-1"> </span><span class="hl-4">used</span><span class="hl-1">, </span><span class="hl-4">unless</span><span class="hl-1"> </span><span class="hl-4">set</span><span class="hl-1"> </span><span class="hl-4">at</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">artifact</span><span class="hl-1"> </span><span class="hl-4">level</span>
|
|
852
873
|
</code><button type="button">Copy</button></pre>
|
|
853
874
|
|
|
854
875
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseEnvironment</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releaseeverycommit"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">release<wbr/>Every<wbr/>Commit</span><a href="#releaseeverycommit" 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">releaseEveryCommit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically release new versions every commit to one of branches in <code>releaseBranches</code>.</p>
|
|
855
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
876
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-115">Default<a href="#default-115" 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-5">true</span>
|
|
856
877
|
</code><button type="button">Copy</button></pre>
|
|
857
878
|
|
|
858
879
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-12">Deprecated<a href="#deprecated-12" 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>Use <code>releaseTrigger: ReleaseTrigger.continuous()</code> instead</p>
|
|
859
880
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseEveryCommit</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releasefailureissue"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Failure<wbr/>Issue</span><a href="#releasefailureissue" 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">releaseFailureIssue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
860
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
881
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-116">Default<a href="#default-116" 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-5">false</span>
|
|
861
882
|
</code><button type="button">Copy</button></pre>
|
|
862
883
|
|
|
863
884
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssue</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releasefailureissuelabel"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><a href="#releasefailureissuelabel" 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">releaseFailureIssueLabel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The label to apply to issues indicating publish failures.
|
|
864
885
|
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
865
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
886
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-117">Default<a href="#default-117" 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">"failed-release"</span>
|
|
866
887
|
</code><button type="button">Copy</button></pre>
|
|
867
888
|
|
|
868
889
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssueLabel</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releaseschedule"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">release<wbr/>Schedule</span><a href="#releaseschedule" 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">releaseSchedule</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>CRON schedule to trigger new releases.</p>
|
|
869
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
890
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-118">Default<a href="#default-118" 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-4">no</span><span class="hl-1"> </span><span class="hl-4">scheduled</span><span class="hl-1"> </span><span class="hl-4">releases</span>
|
|
870
891
|
</code><button type="button">Copy</button></pre>
|
|
871
892
|
|
|
872
893
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-13">Deprecated<a href="#deprecated-13" 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>Use <code>releaseTrigger: ReleaseTrigger.scheduled()</code> instead</p>
|
|
@@ -877,38 +898,38 @@ version numbers.</p>
|
|
|
877
898
|
when bumping, so if you change this on a project with an existing version
|
|
878
899
|
history, you may need to manually tag your latest release
|
|
879
900
|
with the new prefix.</p>
|
|
880
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
901
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-119">Default<a href="#default-119" 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">"v"</span>
|
|
881
902
|
</code><button type="button">Copy</button></pre>
|
|
882
903
|
|
|
883
904
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTagPrefix</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releasetonpm"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>To<wbr/>Npm</span><a href="#releasetonpm" 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">releaseToNpm</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
884
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
905
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-120">Default<a href="#default-120" 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-5">false</span>
|
|
885
906
|
</code><button type="button">Copy</button></pre>
|
|
886
907
|
|
|
887
908
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseToNpm</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releasetrigger"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Trigger</span><a href="#releasetrigger" 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">releaseTrigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleaseTrigger</span></div><div class="tsd-comment tsd-typography"><p>The release trigger to use.</p>
|
|
888
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
909
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-121">Default<a href="#default-121" 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><ul>
|
|
889
910
|
<li>Continuous releases (<code>ReleaseTrigger.continuous()</code>)</li>
|
|
890
911
|
</ul>
|
|
891
912
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTrigger</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releaseworkflow"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">release<wbr/>Workflow</span><a href="#releaseworkflow" 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">releaseWorkflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>DEPRECATED: renamed to <code>release</code>.</p>
|
|
892
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
913
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-122">Default<a href="#default-122" 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">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
|
|
893
914
|
</code><button type="button">Copy</button></pre>
|
|
894
915
|
|
|
895
916
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-14">Deprecated<a href="#deprecated-14" 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>see <code>release</code>.</p>
|
|
896
917
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflow</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releaseworkflowenv"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Workflow<wbr/>Env</span><a href="#releaseworkflowenv" 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">releaseWorkflowEnv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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>Build environment variables for release workflows.</p>
|
|
897
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
918
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-123">Default<a href="#default-123" 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>
|
|
898
919
|
</code><button type="button">Copy</button></pre>
|
|
899
920
|
|
|
900
921
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowEnv</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releaseworkflowname"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Workflow<wbr/>Name</span><a href="#releaseworkflowname" 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">releaseWorkflowName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
901
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
922
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-124">Default<a href="#default-124" 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">"release"</span>
|
|
902
923
|
</code><button type="button">Copy</button></pre>
|
|
903
924
|
|
|
904
925
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowName</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="releaseworkflowsetupsteps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><a href="#releaseworkflowsetupsteps" 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">releaseWorkflowSetupSteps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A set of workflow steps to execute in order to setup the workflow
|
|
905
926
|
container.</p>
|
|
906
927
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowSetupSteps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="renovatebot"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>renovatebot</span><a href="#renovatebot" 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">renovatebot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
907
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
928
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-125">Default<a href="#default-125" 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-5">false</span>
|
|
908
929
|
</code><button type="button">Copy</button></pre>
|
|
909
930
|
|
|
910
931
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebot</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="renovatebotoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>renovatebot<wbr/>Options</span><a href="#renovatebotoptions" 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">renovatebotOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenovatebotOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
911
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
932
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-126">Default<a href="#default-126" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
912
933
|
</code><button type="button">Copy</button></pre>
|
|
913
934
|
|
|
914
935
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebotOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="repository"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>repository</span><a href="#repository" 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">repository</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The repository is the location where the actual code for your package lives.
|
|
@@ -917,41 +938,41 @@ See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-repository">h
|
|
|
917
938
|
you can specify the directory in which it lives.</p>
|
|
918
939
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repositoryDirectory</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="requireapproval"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>require<wbr/>Approval</span><a href="#requireapproval" 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">requireApproval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ApprovalLevel</span></div><div class="tsd-comment tsd-typography"><p>To protect you against unintended changes that affect your security posture,
|
|
919
940
|
the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.</p>
|
|
920
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
941
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-127">Default<a href="#default-127" 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-4">ApprovalLevel</span><span class="hl-1">.</span><span class="hl-7">BROADENING</span>
|
|
921
942
|
</code><button type="button">Copy</button></pre>
|
|
922
943
|
|
|
923
944
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.requireApproval</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="samplecode"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>sample<wbr/>Code</span><a href="#samplecode" 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">sampleCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate one-time sample in <code>src/</code> and <code>test/</code> if there are no files there.</p>
|
|
924
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
945
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-128">Default<a href="#default-128" 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-5">true</span>
|
|
925
946
|
</code><button type="button">Copy</button></pre>
|
|
926
947
|
|
|
927
948
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.sampleCode</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scopedpackagesoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>scoped<wbr/>Packages<wbr/>Options</span><a href="#scopedpackagesoptions" 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">scopedPackagesOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages</p>
|
|
928
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
949
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-129">Default<a href="#default-129" 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-4">fetch</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">scoped</span><span class="hl-1"> </span><span class="hl-4">packages</span><span class="hl-1"> </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-4">registry</span>
|
|
929
950
|
</code><button type="button">Copy</button></pre>
|
|
930
951
|
|
|
931
952
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scopedPackagesOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scripts"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">scripts</span><a href="#scripts" 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">scripts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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>npm scripts to include. If a script has the same name as a standard script,
|
|
932
953
|
the standard script will be overwritten.
|
|
933
954
|
Also adds the script as a task.</p>
|
|
934
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
955
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-130">Default<a href="#default-130" 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>
|
|
935
956
|
</code><button type="button">Copy</button></pre>
|
|
936
957
|
|
|
937
958
|
</div><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-15">Deprecated<a href="#deprecated-15" 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>use <code>project.addTask()</code> or <code>package.setScript()</code></p>
|
|
938
959
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scripts</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="singletonlambdaautodiscover"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>singleton<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><a href="#singletonlambdaautodiscover" 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">singletonLambdaAutoDiscover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.SingletonFunction</code> for each
|
|
939
960
|
<code>.singleton-lambda.ts</code> handler in your source tree. If this is disabled, you can
|
|
940
961
|
manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
941
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
962
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-131">Default<a href="#default-131" 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-5">true</span>
|
|
942
963
|
</code><button type="button">Copy</button></pre>
|
|
943
964
|
|
|
944
965
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.singletonLambdaAutoDiscover</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="srcdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>srcdir</span><a href="#srcdir" 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">srcdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
945
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
966
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-132">Default<a href="#default-132" 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">"src"</span>
|
|
946
967
|
</code><button type="button">Copy</button></pre>
|
|
947
968
|
|
|
948
969
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.srcdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="stability"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>stability</span><a href="#stability" 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">stability</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Package's Stability</p>
|
|
949
970
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stability</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="stale"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>stale</span><a href="#stale" 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">stale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request. See <code>staleOptions</code> for options.</p>
|
|
950
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
971
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-133">Default<a href="#default-133" 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-5">false</span>
|
|
951
972
|
</code><button type="button">Copy</button></pre>
|
|
952
973
|
|
|
953
974
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stale</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="staleoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>stale<wbr/>Options</span><a href="#staleoptions" 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">staleOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaleOptions</span></div><div class="tsd-comment tsd-typography"><p>Auto-close stale issues and pull requests. To disable set <code>stale</code> to <code>false</code>.</p>
|
|
954
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
975
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-134">Default<a href="#default-134" 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><ul>
|
|
955
976
|
<li>see defaults in <code>StaleOptions</code></li>
|
|
956
977
|
</ul>
|
|
957
978
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.staleOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="testdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>testdir</span><a href="#testdir" 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">testdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Jest tests directory. Tests files should be named <code>xxx.test.ts</code>.</p>
|
|
@@ -959,69 +980,69 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
959
980
|
then tests are going to be compiled into <code>lib/</code> and executed as javascript.
|
|
960
981
|
If the test directory is outside of <code>src</code>, then we configure jest to
|
|
961
982
|
compile the code in-memory.</p>
|
|
962
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
983
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-135">Default<a href="#default-135" 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">"test"</span>
|
|
963
984
|
</code><button type="button">Copy</button></pre>
|
|
964
985
|
|
|
965
986
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.testdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="tsconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig</span><a href="#tsconfig" 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">tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span></div><div class="tsd-comment tsd-typography"><p>Custom TSConfig</p>
|
|
966
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
987
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-136">Default<a href="#default-136" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
967
988
|
</code><button type="button">Copy</button></pre>
|
|
968
989
|
|
|
969
990
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfig</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="tsconfigdev"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig<wbr/>Dev</span><a href="#tsconfigdev" 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">tsconfigDev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span></div><div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
970
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
991
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-137">Default<a href="#default-137" 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-4">use</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">production</span><span class="hl-1"> </span><span class="hl-4">tsconfig</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
971
992
|
</code><button type="button">Copy</button></pre>
|
|
972
993
|
|
|
973
994
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDev</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="tsconfigdevfile"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig<wbr/>Dev<wbr/>File</span><a href="#tsconfigdevfile" 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">tsconfigDevFile</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the development tsconfig.json file.</p>
|
|
974
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
995
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-138">Default<a href="#default-138" 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">"tsconfig.dev.json"</span>
|
|
975
996
|
</code><button type="button">Copy</button></pre>
|
|
976
997
|
|
|
977
998
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDevFile</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="tsjestoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>ts<wbr/>Jest<wbr/>Options</span><a href="#tsjestoptions" 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">tsJestOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TsJestOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for ts-jest</p>
|
|
978
999
|
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsJestOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="typescriptversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>typescript<wbr/>Version</span><a href="#typescriptversion" 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">typescriptVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>TypeScript version to use.</p>
|
|
979
1000
|
<p>NOTE: Typescript is not semantically versioned and should remain on the
|
|
980
1001
|
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
981
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1002
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-139">Default<a href="#default-139" 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">"latest"</span>
|
|
982
1003
|
</code><button type="button">Copy</button></pre>
|
|
983
1004
|
|
|
984
1005
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.typescriptVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="versionrcoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>versionrc<wbr/>Options</span><a href="#versionrcoptions" 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">versionrcOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Custom configuration used when creating changelog with commit-and-tag-version package.
|
|
985
1006
|
Given values either append to default configuration or overwrite values in it.</p>
|
|
986
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1007
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-140">Default<a href="#default-140" 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-4">standard</span><span class="hl-1"> </span><span class="hl-4">configuration</span><span class="hl-1"> </span><span class="hl-4">applicable</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">GitHub</span><span class="hl-1"> </span><span class="hl-4">repositories</span>
|
|
987
1008
|
</code><button type="button">Copy</button></pre>
|
|
988
1009
|
|
|
989
1010
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.versionrcOptions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="vscode"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>vscode</span><a href="#vscode" 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">vscode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable VSCode integration.</p>
|
|
990
1011
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
991
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1012
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-141">Default<a href="#default-141" 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-5">true</span>
|
|
992
1013
|
</code><button type="button">Copy</button></pre>
|
|
993
1014
|
|
|
994
1015
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.vscode</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="watchexcludes"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>watch<wbr/>Excludes</span><a href="#watchexcludes" 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">watchExcludes</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>Glob patterns to exclude from <code>cdk watch</code>.</p>
|
|
995
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1016
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-142">Default<a href="#default-142" 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>
|
|
996
1017
|
</code><button type="button">Copy</button></pre>
|
|
997
1018
|
|
|
998
1019
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchExcludes</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="watchincludes"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>watch<wbr/>Includes</span><a href="#watchincludes" 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">watchIncludes</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>Glob patterns to include in <code>cdk watch</code>.</p>
|
|
999
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1020
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-143">Default<a href="#default-143" 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>
|
|
1000
1021
|
</code><button type="button">Copy</button></pre>
|
|
1001
1022
|
|
|
1002
1023
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchIncludes</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="workflowbootstrapsteps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowbootstrapsteps" 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">workflowBootstrapSteps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
1003
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1024
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-144">Default<a href="#default-144" 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">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
1004
1025
|
</code><button type="button">Copy</button></pre>
|
|
1005
1026
|
|
|
1006
1027
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowBootstrapSteps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="workflowcontainerimage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Container<wbr/>Image</span><a href="#workflowcontainerimage" 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">workflowContainerImage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
1007
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1028
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-145">Default<a href="#default-145" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">image</span>
|
|
1008
1029
|
</code><button type="button">Copy</button></pre>
|
|
1009
1030
|
|
|
1010
1031
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowContainerImage</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="workflowgitidentity"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Git<wbr/>Identity</span><a href="#workflowgitidentity" 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">workflowGitIdentity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitIdentity</span></div><div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
1011
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1032
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-146">Default<a href="#default-146" 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-3">default</span><span class="hl-1"> </span><span class="hl-4">GitHub</span><span class="hl-1"> </span><span class="hl-4">Actions</span><span class="hl-1"> </span><span class="hl-4">user</span>
|
|
1012
1033
|
</code><button type="button">Copy</button></pre>
|
|
1013
1034
|
|
|
1014
1035
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowGitIdentity</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="workflownodeversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Node<wbr/>Version</span><a href="#workflownodeversion" 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">workflowNodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The node version used in GitHub Actions workflows.</p>
|
|
1015
1036
|
<p>Always use this option if your GitHub Actions workflows require a specific to run.</p>
|
|
1016
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1037
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-147">Default<a href="#default-147" 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><ul>
|
|
1017
1038
|
<li><code>minNodeVersion</code> if set, otherwise <code>lts/*</code>.</li>
|
|
1018
1039
|
</ul>
|
|
1019
1040
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowNodeVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="workflowpackagecache"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Package<wbr/>Cache</span><a href="#workflowpackagecache" 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">workflowPackageCache</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable Node.js package cache in GitHub workflows.</p>
|
|
1020
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1041
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-148">Default<a href="#default-148" 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-5">false</span>
|
|
1021
1042
|
</code><button type="button">Copy</button></pre>
|
|
1022
1043
|
|
|
1023
1044
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowPackageCache</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="workflowrunson"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Runs<wbr/>On</span><a href="#workflowrunson" 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">workflowRunsOn</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>Github Runner selection labels</p>
|
|
1024
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1045
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-149">Default<a href="#default-149" 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-2">"ubuntu-latest"</span><span class="hl-1">]</span>
|
|
1025
1046
|
</code><button type="button">Copy</button></pre>
|
|
1026
1047
|
|
|
1027
1048
|
</div><div class="tsd-tag-description"><h4 class="tsd-anchor-link" id="description-1">Description<a href="#description-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><p>Defines a target Runner by labels</p>
|
|
@@ -1030,7 +1051,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1030
1051
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-description"><h4 class="tsd-anchor-link" id="description-2">Description<a href="#description-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><p>Defines a target Runner Group by name and/or labels</p>
|
|
1031
1052
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-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><p>if both <code>runsOn</code> and <code>runsOnGroup</code> are specified</p>
|
|
1032
1053
|
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowRunsOnGroup</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="yarnberryoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>yarn<wbr/>Berry<wbr/>Options</span><a href="#yarnberryoptions" 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">yarnBerryOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">YarnBerryOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for Yarn Berry</p>
|
|
1033
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1054
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-150">Default<a href="#default-150" 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-4">Yarn</span><span class="hl-1"> </span><span class="hl-4">Berry</span><span class="hl-1"> </span><span class="hl-4">v4</span><span class="hl-1"> </span><span class="hl-3">with</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1034
1055
|
</code><button type="button">Copy</button></pre>
|
|
1035
1056
|
|
|
1036
|
-
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.yarnBerryOptions</p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#allowlibrarydependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a><a href="#app" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app</span></a><a href="#appentrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a><a href="#artifactsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a><a href="#auditdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps</span></a><a href="#auditdepsoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps<wbr/>Options</span></a><a href="#authoremail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Email</span></a><a href="#authorname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Name</span></a><a href="#authororganization" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Organization</span></a><a href="#authorurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Url</span></a><a href="#autoapproveoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Options</span></a><a href="#autoapproveupgrades" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Upgrades</span></a><a href="#autodetectbin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Detect<wbr/>Bin</span></a><a href="#automerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#automergeoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge<wbr/>Options</span></a><a href="#bin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bin</span></a><a href="#biome" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome</span></a><a href="#biomeoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome<wbr/>Options</span></a><a href="#bugsemail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Email</span></a><a href="#bugsurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Url</span></a><a href="#buildcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Command</span></a><a href="#buildworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a><a href="#buildworkflowoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow<wbr/>Options</span></a><a href="#buildworkflowtriggers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow<wbr/>Triggers</span></a><a href="#bumppackage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bump<wbr/>Package</span></a><a href="#bundleddeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundled<wbr/>Deps</span></a><a href="#bundleroptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler<wbr/>Options</span></a><a href="#bunversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bun<wbr/>Version</span></a><a href="#cdkassert" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Assert</span></a><a href="#cdkassertions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Assertions</span></a><a href="#cdkcliversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Cli<wbr/>Version</span></a><a href="#cdkdependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Dependencies</span></a><a href="#cdkdependenciesasdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span></a><a href="#cdkout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdkout</span></a><a href="#cdktestdependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Test<wbr/>Dependencies</span></a><a href="#cdkversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Version</span></a><a href="#cdkversionpinning" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Version<wbr/>Pinning</span></a><a href="#checklicenses" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>check<wbr/>Licenses</span></a><a href="#clobber" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clobber</span></a><a href="#codeartifactoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Artifact<wbr/>Options</span></a><a href="#codecov" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov</span></a><a href="#codecovtokensecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span></a><a href="#commitgenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a><a href="#constructsversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>constructs<wbr/>Version</span></a><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a><a href="#copyrightowner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Owner</span></a><a href="#copyrightperiod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Period</span></a><a href="#defaultreleasebranch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a><a href="#dependabot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot</span></a><a href="#dependabotoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot<wbr/>Options</span></a><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a><a href="#depsupgrade" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade</span></a><a href="#depsupgradeoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade<wbr/>Options</span></a><a href="#description" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#devcontainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a><a href="#devdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Deps</span></a><a href="#disabletsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig</span></a><a href="#disabletsconfigdev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev</span></a><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen</span></a><a href="#docsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a><a href="#edgelambdaautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span></a><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint</span></a><a href="#entrypointtypes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint<wbr/>Types</span></a><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint</span></a><a href="#eslintoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint<wbr/>Options</span></a><a href="#experimentalintegrunner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>experimental<wbr/>Integ<wbr/>Runner</span></a><a href="#featureflags" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>feature<wbr/>Flags</span></a><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a><a href="#githuboptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github<wbr/>Options</span></a><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a><a href="#gitignoreoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Ignore<wbr/>Options</span></a><a href="#gitoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Options</span></a><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a><a href="#homepage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homepage</span></a><a href="#integrationtestautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span></a><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest</span></a><a href="#jestoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest<wbr/>Options</span></a><a href="#jsiireleaseversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Release<wbr/>Version</span></a><a href="#keywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keywords</span></a><a href="#lambdaautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Auto<wbr/>Discover</span></a><a href="#lambdaextensionautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span></a><a href="#lambdaoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a><a href="#license" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>license</span></a><a href="#licensed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>licensed</span></a><a href="#logging" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logging</span></a><a href="#majorversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>major<wbr/>Version</span></a><a href="#maxnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a><a href="#mergify" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mergify</span></a><a href="#mergifyoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mergify<wbr/>Options</span></a><a href="#minmajorversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Major<wbr/>Version</span></a><a href="#minnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a><a href="#mutablebuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mutable<wbr/>Build</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#nextversioncommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Version<wbr/>Command</span></a><a href="#npmaccess" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Access</span></a><a href="#npmdisttag" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Dist<wbr/>Tag</span></a><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore</span></a><a href="#npmignoreenabled" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore<wbr/>Enabled</span></a><a href="#npmignoreoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Ignore<wbr/>Options</span></a><a href="#npmprovenance" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Provenance</span></a><a href="#npmregistry" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Registry</span></a><a href="#npmregistryurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Registry<wbr/>Url</span></a><a href="#npmtokensecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Token<wbr/>Secret</span></a><a href="#npmtrustedpublishing" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Trusted<wbr/>Publishing</span></a><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a><a href="#packagemanager" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Manager</span></a><a href="#packagename" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Name</span></a><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#peerdependencyoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Dependency<wbr/>Options</span></a><a href="#peerdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Deps</span></a><a href="#pnpmversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pnpm<wbr/>Version</span></a><a href="#postbuildsteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Build<wbr/>Steps</span></a><a href="#prerelease" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prerelease</span></a><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier</span></a><a href="#prettieroptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier<wbr/>Options</span></a><a href="#projecttree" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Tree</span></a><a href="#projecttype" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Type</span></a><a href="#projencommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Command</span></a><a href="#projencredentials" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Credentials</span></a><a href="#projendevdependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Dev<wbr/>Dependency</span></a><a href="#projenrcjs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js</span></a><a href="#projenrcjson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json</span></a><a href="#projenrcjsonoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json<wbr/>Options</span></a><a href="#projenrcjsoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js<wbr/>Options</span></a><a href="#projenrcts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts</span></a><a href="#projenrctsoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options</span></a><a href="#projentokensecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Token<wbr/>Secret</span></a><a href="#projenversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Version</span></a><a href="#publishdryrun" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Dry<wbr/>Run</span></a><a href="#publishtasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Tasks</span></a><a href="#pullrequesttemplate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a><a href="#pullrequesttemplatecontents" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a><a href="#readme" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>readme</span></a><a href="#releasablecommits" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release</span></a><a href="#releasebranches" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Branches</span></a><a href="#releaseenvironment" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Environment</span></a><a href="#releaseeverycommit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Every<wbr/>Commit</span></a><a href="#releasefailureissue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue</span></a><a href="#releasefailureissuelabel" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span></a><a href="#releaseschedule" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Schedule</span></a><a href="#releasetagprefix" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Tag<wbr/>Prefix</span></a><a href="#releasetonpm" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>To<wbr/>Npm</span></a><a href="#releasetrigger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Trigger</span></a><a href="#releaseworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow</span></a><a href="#releaseworkflowenv" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Env</span></a><a href="#releaseworkflowname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Name</span></a><a href="#releaseworkflowsetupsteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span></a><a href="#renovatebot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot</span></a><a href="#renovatebotoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot<wbr/>Options</span></a><a href="#repository" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository</span></a><a href="#repositorydirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository<wbr/>Directory</span></a><a href="#requireapproval" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>require<wbr/>Approval</span></a><a href="#samplecode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sample<wbr/>Code</span></a><a href="#scopedpackagesoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scoped<wbr/>Packages<wbr/>Options</span></a><a href="#scripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scripts</span></a><a href="#singletonlambdaautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>singleton<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span></a><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a><a href="#stability" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stability</span></a><a href="#stale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale</span></a><a href="#staleoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale<wbr/>Options</span></a><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig</span></a><a href="#tsconfigdev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a><a href="#tsconfigdevfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev<wbr/>File</span></a><a href="#tsjestoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ts<wbr/>Jest<wbr/>Options</span></a><a href="#typescriptversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typescript<wbr/>Version</span></a><a href="#versionrcoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>versionrc<wbr/>Options</span></a><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a><a href="#watchexcludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Excludes</span></a><a href="#watchincludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Includes</span></a><a href="#workflowbootstrapsteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a><a href="#workflowcontainerimage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Container<wbr/>Image</span></a><a href="#workflowgitidentity" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Git<wbr/>Identity</span></a><a href="#workflownodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Node<wbr/>Version</span></a><a href="#workflowpackagecache" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a><a href="#workflowrunson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On</span></a><a href="#workflowrunsongroup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On<wbr/>Group</span></a><a href="#yarnberryoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1057
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.yarnBerryOptions</p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#addpackagemanagertodevengines" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines</span></a><a href="#allowlibrarydependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a><a href="#app" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app</span></a><a href="#appentrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a><a href="#artifactsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a><a href="#auditdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps</span></a><a href="#auditdepsoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps<wbr/>Options</span></a><a href="#authoremail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Email</span></a><a href="#authorname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Name</span></a><a href="#authororganization" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Organization</span></a><a href="#authorurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Url</span></a><a href="#autoapproveoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Options</span></a><a href="#autoapproveupgrades" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Upgrades</span></a><a href="#autodetectbin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Detect<wbr/>Bin</span></a><a href="#automerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#automergeoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge<wbr/>Options</span></a><a href="#bin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bin</span></a><a href="#biome" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome</span></a><a href="#biomeoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome<wbr/>Options</span></a><a href="#bugsemail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Email</span></a><a href="#bugsurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Url</span></a><a href="#buildcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Command</span></a><a href="#buildworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a><a href="#buildworkflowoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow<wbr/>Options</span></a><a href="#buildworkflowtriggers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow<wbr/>Triggers</span></a><a href="#bumppackage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bump<wbr/>Package</span></a><a href="#bundleddeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundled<wbr/>Deps</span></a><a href="#bundleroptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler<wbr/>Options</span></a><a href="#bunversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bun<wbr/>Version</span></a><a href="#cdkassert" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Assert</span></a><a href="#cdkassertions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Assertions</span></a><a href="#cdkcliversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Cli<wbr/>Version</span></a><a href="#cdkdependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Dependencies</span></a><a href="#cdkdependenciesasdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span></a><a href="#cdkout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdkout</span></a><a href="#cdktestdependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Test<wbr/>Dependencies</span></a><a href="#cdkversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Version</span></a><a href="#cdkversionpinning" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Version<wbr/>Pinning</span></a><a href="#checklicenses" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>check<wbr/>Licenses</span></a><a href="#clobber" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clobber</span></a><a href="#codeartifactoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Artifact<wbr/>Options</span></a><a href="#codecov" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov</span></a><a href="#codecovtokensecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span></a><a href="#commitgenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a><a href="#constructsversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>constructs<wbr/>Version</span></a><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a><a href="#copyrightowner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Owner</span></a><a href="#copyrightperiod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Period</span></a><a href="#defaultreleasebranch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a><a href="#deleteorphanedlockfiles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files</span></a><a href="#dependabot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot</span></a><a href="#dependabotoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot<wbr/>Options</span></a><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a><a href="#depsupgrade" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade</span></a><a href="#depsupgradeoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade<wbr/>Options</span></a><a href="#description" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#devcontainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a><a href="#devdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Deps</span></a><a href="#devengines" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Engines</span></a><a href="#disabletsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig</span></a><a href="#disabletsconfigdev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev</span></a><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen</span></a><a href="#docsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a><a href="#edgelambdaautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span></a><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint</span></a><a href="#entrypointtypes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint<wbr/>Types</span></a><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint</span></a><a href="#eslintoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint<wbr/>Options</span></a><a href="#experimentalintegrunner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>experimental<wbr/>Integ<wbr/>Runner</span></a><a href="#featureflags" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>feature<wbr/>Flags</span></a><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a><a href="#githuboptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github<wbr/>Options</span></a><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a><a href="#gitignoreoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Ignore<wbr/>Options</span></a><a href="#gitoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Options</span></a><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a><a href="#homepage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homepage</span></a><a href="#integrationtestautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span></a><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest</span></a><a href="#jestoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest<wbr/>Options</span></a><a href="#jsiireleaseversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Release<wbr/>Version</span></a><a href="#keywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keywords</span></a><a href="#lambdaautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Auto<wbr/>Discover</span></a><a href="#lambdaextensionautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span></a><a href="#lambdaoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a><a href="#license" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>license</span></a><a href="#licensed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>licensed</span></a><a href="#logging" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logging</span></a><a href="#majorversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>major<wbr/>Version</span></a><a href="#maxnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a><a href="#mergify" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mergify</span></a><a href="#mergifyoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mergify<wbr/>Options</span></a><a href="#minmajorversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Major<wbr/>Version</span></a><a href="#minnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a><a href="#mutablebuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mutable<wbr/>Build</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#nextversioncommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Version<wbr/>Command</span></a><a href="#npmaccess" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Access</span></a><a href="#npmdisttag" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Dist<wbr/>Tag</span></a><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore</span></a><a href="#npmignoreenabled" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore<wbr/>Enabled</span></a><a href="#npmignoreoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Ignore<wbr/>Options</span></a><a href="#npmprovenance" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Provenance</span></a><a href="#npmregistry" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Registry</span></a><a href="#npmregistryurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Registry<wbr/>Url</span></a><a href="#npmtokensecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Token<wbr/>Secret</span></a><a href="#npmtrustedpublishing" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Trusted<wbr/>Publishing</span></a><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a><a href="#packagemanager" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Manager</span></a><a href="#packagename" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Name</span></a><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#peerdependencyoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Dependency<wbr/>Options</span></a><a href="#peerdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Deps</span></a><a href="#pnpmversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pnpm<wbr/>Version</span></a><a href="#postbuildsteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Build<wbr/>Steps</span></a><a href="#prerelease" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prerelease</span></a><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier</span></a><a href="#prettieroptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier<wbr/>Options</span></a><a href="#projecttree" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Tree</span></a><a href="#projecttype" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Type</span></a><a href="#projencommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Command</span></a><a href="#projencredentials" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Credentials</span></a><a href="#projendevdependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Dev<wbr/>Dependency</span></a><a href="#projenrcjs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js</span></a><a href="#projenrcjson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json</span></a><a href="#projenrcjsonoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json<wbr/>Options</span></a><a href="#projenrcjsoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js<wbr/>Options</span></a><a href="#projenrcts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts</span></a><a href="#projenrctsoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options</span></a><a href="#projentokensecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Token<wbr/>Secret</span></a><a href="#projenversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Version</span></a><a href="#publishdryrun" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Dry<wbr/>Run</span></a><a href="#publishtasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Tasks</span></a><a href="#pullrequesttemplate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a><a href="#pullrequesttemplatecontents" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a><a href="#readme" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>readme</span></a><a href="#releasablecommits" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release</span></a><a href="#releasebranches" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Branches</span></a><a href="#releaseenvironment" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Environment</span></a><a href="#releaseeverycommit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Every<wbr/>Commit</span></a><a href="#releasefailureissue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue</span></a><a href="#releasefailureissuelabel" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span></a><a href="#releaseschedule" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Schedule</span></a><a href="#releasetagprefix" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Tag<wbr/>Prefix</span></a><a href="#releasetonpm" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>To<wbr/>Npm</span></a><a href="#releasetrigger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Trigger</span></a><a href="#releaseworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow</span></a><a href="#releaseworkflowenv" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Env</span></a><a href="#releaseworkflowname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Name</span></a><a href="#releaseworkflowsetupsteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span></a><a href="#renovatebot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot</span></a><a href="#renovatebotoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot<wbr/>Options</span></a><a href="#repository" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository</span></a><a href="#repositorydirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository<wbr/>Directory</span></a><a href="#requireapproval" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>require<wbr/>Approval</span></a><a href="#samplecode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sample<wbr/>Code</span></a><a href="#scopedpackagesoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scoped<wbr/>Packages<wbr/>Options</span></a><a href="#scripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scripts</span></a><a href="#singletonlambdaautodiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>singleton<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span></a><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a><a href="#stability" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stability</span></a><a href="#stale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale</span></a><a href="#staleoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale<wbr/>Options</span></a><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig</span></a><a href="#tsconfigdev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a><a href="#tsconfigdevfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev<wbr/>File</span></a><a href="#tsjestoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ts<wbr/>Jest<wbr/>Options</span></a><a href="#typescriptversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typescript<wbr/>Version</span></a><a href="#versionrcoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>versionrc<wbr/>Options</span></a><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a><a href="#watchexcludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Excludes</span></a><a href="#watchincludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Includes</span></a><a href="#workflowbootstrapsteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a><a href="#workflowcontainerimage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Container<wbr/>Image</span></a><a href="#workflowgitidentity" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Git<wbr/>Identity</span></a><a href="#workflownodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Node<wbr/>Version</span></a><a href="#workflowpackagecache" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a><a href="#workflowrunson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On</span></a><a href="#workflowrunsongroup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On<wbr/>Group</span></a><a href="#yarnberryoptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|