cdk-serverless 1.1.44 → 2.0.0
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/README.md +3 -116
- package/docs/constructs/.nojekyll +1 -0
- package/docs/constructs/assets/highlight.css +92 -0
- package/docs/constructs/assets/main.js +58 -0
- package/docs/constructs/assets/search.js +1 -0
- package/docs/constructs/assets/style.css +1338 -0
- package/docs/constructs/classes/AssetCdn.html +165 -0
- package/docs/constructs/classes/BaseApi.html +152 -0
- package/docs/constructs/classes/CognitoAuthentication.html +172 -0
- package/docs/constructs/classes/LambdaFunction.html +1101 -0
- package/docs/constructs/classes/RestApi.html +306 -0
- package/docs/constructs/classes/SingleTableDatastore.html +155 -0
- package/docs/constructs/classes/Workflow.html +170 -0
- package/docs/constructs/index.html +122 -0
- package/docs/constructs/interfaces/AssetCdnProps.html +89 -0
- package/docs/constructs/interfaces/BaseApiProps.html +158 -0
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +151 -0
- package/docs/constructs/interfaces/ICognitoAuthentication.html +86 -0
- package/docs/constructs/interfaces/IJwtAuthentication.html +96 -0
- package/docs/constructs/interfaces/LambdaFunctionProps.html +189 -0
- package/docs/constructs/interfaces/LambdaTracingOptions.html +85 -0
- package/docs/constructs/interfaces/RestApiProps.html +227 -0
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +109 -0
- package/docs/constructs/interfaces/SingleTableDesign.html +113 -0
- package/docs/constructs/interfaces/WorkflowProps.html +105 -0
- package/docs/constructs/modules.html +85 -0
- package/docs/constructs/types/LambdaOptions.html +58 -0
- package/docs/lambda/.nojekyll +1 -0
- package/docs/lambda/assets/highlight.css +36 -0
- package/docs/lambda/assets/main.js +58 -0
- package/docs/lambda/assets/search.js +1 -0
- package/docs/lambda/assets/style.css +1338 -0
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +323 -0
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +322 -0
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +324 -0
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +320 -0
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +314 -0
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +303 -0
- package/docs/lambda/classes/auth.JwtAuthorizer.html +298 -0
- package/docs/lambda/classes/errors.BadRequestError.html +193 -0
- package/docs/lambda/classes/errors.ForbiddenError.html +193 -0
- package/docs/lambda/classes/errors.HttpError.html +199 -0
- package/docs/lambda/classes/errors.NotFoundError.html +193 -0
- package/docs/lambda/classes/errors.UnauthenticatedError.html +193 -0
- package/docs/lambda/functions/api.createAppSyncHandler.html +98 -0
- package/docs/lambda/functions/api.createHttpHandler.html +95 -0
- package/docs/lambda/functions/api.createOpenApiHandler.html +95 -0
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +95 -0
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +93 -0
- package/docs/lambda/index.html +140 -0
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +123 -0
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +122 -0
- package/docs/lambda/interfaces/api.HttpResponseContext.html +117 -0
- package/docs/lambda/interfaces/api.Operation.html +109 -0
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +123 -0
- package/docs/lambda/modules/api.html +100 -0
- package/docs/lambda/modules/auth.html +88 -0
- package/docs/lambda/modules/errors.html +86 -0
- package/docs/lambda/modules.html +81 -0
- package/docs/lambda/types/api.APIGatewayv1Handler.html +79 -0
- package/docs/lambda/types/api.AppSyncHandler.html +100 -0
- package/docs/lambda/types/api.HttpHandler.html +101 -0
- package/docs/projen/.nojekyll +1 -0
- package/docs/projen/assets/highlight.css +85 -0
- package/docs/projen/assets/main.js +58 -0
- package/docs/projen/assets/search.js +1 -0
- package/docs/projen/assets/style.css +1338 -0
- package/docs/projen/classes/Datastore.html +180 -0
- package/docs/projen/classes/RestApi.html +184 -0
- package/docs/projen/classes/ServerlessProject.html +1246 -0
- package/docs/projen/classes/Workflow.html +178 -0
- package/docs/projen/index.html +112 -0
- package/docs/projen/interfaces/DatastoreOptions.html +75 -0
- package/docs/projen/interfaces/RestApiOptions.html +75 -0
- package/docs/projen/interfaces/ServerlessProjectOptions.html +1921 -0
- package/docs/projen/interfaces/WorkflowOptions.html +75 -0
- package/docs/projen/modules.html +65 -0
- package/docs/projen/variables/PACKAGE_NAME.html +48 -0
- package/lib/constructs/asset-cdn.js +2 -1
- package/lib/constructs/{auth.d.ts → authentication.d.ts} +32 -15
- package/lib/constructs/authentication.js +136 -0
- package/lib/constructs/base-api.d.ts +10 -21
- package/lib/constructs/base-api.js +2 -37
- package/lib/constructs/func.d.ts +6 -25
- package/lib/constructs/func.js +16 -37
- package/lib/constructs/index.d.ts +4 -6
- package/lib/constructs/index.js +5 -7
- package/lib/constructs/rest-api.d.ts +73 -0
- package/lib/constructs/rest-api.js +278 -0
- package/lib/constructs/table.d.ts +25 -6
- package/lib/constructs/table.js +12 -70
- package/lib/constructs/workflow.d.ts +18 -0
- package/lib/constructs/workflow.js +58 -0
- package/lib/lambda/auth.d.ts +144 -0
- package/lib/lambda/auth.js +309 -0
- package/lib/lambda/errors.d.ts +16 -0
- package/lib/lambda/errors.js +35 -0
- package/lib/lambda/handler.d.ts +90 -0
- package/lib/lambda/handler.js +217 -0
- package/lib/lambda/index.d.ts +3 -0
- package/lib/lambda/index.js +30 -0
- package/lib/projen/core.d.ts +4 -14
- package/lib/projen/core.js +25 -29
- package/lib/projen/datastore.d.ts +13 -0
- package/lib/projen/datastore.js +145 -0
- package/lib/projen/index.d.ts +3 -2
- package/lib/projen/index.js +5 -3
- package/lib/projen/rest-api.d.ts +13 -0
- package/lib/projen/rest-api.js +127 -0
- package/lib/projen/workflow.d.ts +18 -0
- package/lib/projen/workflow.js +99 -0
- package/package.json +44 -35
- package/CHANGELOG.md +0 -170
- package/img/autocomplete.gif +0 -0
- package/lib/constructs/auth.js +0 -135
- package/lib/constructs/graphql-api.d.ts +0 -44
- package/lib/constructs/graphql-api.js +0 -221
- package/lib/constructs/http-api.d.ts +0 -58
- package/lib/constructs/http-api.js +0 -242
- package/lib/constructs/monitoring.d.ts +0 -23
- package/lib/constructs/monitoring.js +0 -47
- package/lib/constructs/scheduled-func.d.ts +0 -63
- package/lib/constructs/scheduled-func.js +0 -54
- package/lib/constructs/webhook.d.ts +0 -33
- package/lib/constructs/webhook.js +0 -86
- package/lib/projen/graphql-api.d.ts +0 -7
- package/lib/projen/graphql-api.js +0 -58
- package/lib/projen/http-api.d.ts +0 -7
- package/lib/projen/http-api.js +0 -43
- package/lib/types/index.d.ts +0 -1
- package/lib/types/index.js +0 -18
- package/lib/types/table.d.ts +0 -34
- package/lib/types/table.js +0 -31
- package/version.json +0 -3
|
@@ -0,0 +1,1921 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../modules.html">cdk-serverless</a></li>
|
|
16
|
+
<li><a href="ServerlessProjectOptions.html">ServerlessProjectOptions</a></li></ul>
|
|
17
|
+
<h1>Interface ServerlessProjectOptions</h1></div>
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
19
|
+
<h4>Hierarchy</h4>
|
|
20
|
+
<ul class="tsd-hierarchy">
|
|
21
|
+
<li><span class="tsd-signature-type ">AwsCdkTypeScriptAppOptions</span>
|
|
22
|
+
<ul class="tsd-hierarchy">
|
|
23
|
+
<li><span class="target">ServerlessProjectOptions</span></li></ul></li></ul></section>
|
|
24
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
25
|
+
<section class="tsd-panel tsd-index-panel">
|
|
26
|
+
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
27
|
+
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
28
|
+
<div class="tsd-accordion-details">
|
|
29
|
+
<section class="tsd-index-section">
|
|
30
|
+
<h3 class="tsd-index-heading">Properties</h3>
|
|
31
|
+
<div class="tsd-index-list"><a href="ServerlessProjectOptions.html#allowLibraryDependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
32
|
+
<a href="ServerlessProjectOptions.html#appEntrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>app<wbr/>Entrypoint?</span></a>
|
|
33
|
+
<a href="ServerlessProjectOptions.html#artifactsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>artifacts<wbr/>Directory?</span></a>
|
|
34
|
+
<a href="ServerlessProjectOptions.html#authorEmail" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Email?</span></a>
|
|
35
|
+
<a href="ServerlessProjectOptions.html#authorName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Name?</span></a>
|
|
36
|
+
<a href="ServerlessProjectOptions.html#authorOrganization" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Organization?</span></a>
|
|
37
|
+
<a href="ServerlessProjectOptions.html#authorUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Url?</span></a>
|
|
38
|
+
<a href="ServerlessProjectOptions.html#autoApproveOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Approve<wbr/>Options?</span></a>
|
|
39
|
+
<a href="ServerlessProjectOptions.html#autoApproveUpgrades" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Approve<wbr/>Upgrades?</span></a>
|
|
40
|
+
<a href="ServerlessProjectOptions.html#autoDetectBin" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Detect<wbr/>Bin?</span></a>
|
|
41
|
+
<a href="ServerlessProjectOptions.html#autoMerge" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Merge?</span></a>
|
|
42
|
+
<a href="ServerlessProjectOptions.html#autoMergeOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Merge<wbr/>Options?</span></a>
|
|
43
|
+
<a href="ServerlessProjectOptions.html#bin" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bin?</span></a>
|
|
44
|
+
<a href="ServerlessProjectOptions.html#bugsEmail" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bugs<wbr/>Email?</span></a>
|
|
45
|
+
<a href="ServerlessProjectOptions.html#bugsUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bugs<wbr/>Url?</span></a>
|
|
46
|
+
<a href="ServerlessProjectOptions.html#buildCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>build<wbr/>Command?</span></a>
|
|
47
|
+
<a href="ServerlessProjectOptions.html#buildWorkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>build<wbr/>Workflow?</span></a>
|
|
48
|
+
<a href="ServerlessProjectOptions.html#buildWorkflowTriggers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>build<wbr/>Workflow<wbr/>Triggers?</span></a>
|
|
49
|
+
<a href="ServerlessProjectOptions.html#bundledDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bundled<wbr/>Deps?</span></a>
|
|
50
|
+
<a href="ServerlessProjectOptions.html#bundlerOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bundler<wbr/>Options?</span></a>
|
|
51
|
+
<a href="ServerlessProjectOptions.html#cdkAssert" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Assert?</span></a>
|
|
52
|
+
<a href="ServerlessProjectOptions.html#cdkAssertions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Assertions?</span></a>
|
|
53
|
+
<a href="ServerlessProjectOptions.html#cdkDependencies" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Dependencies?</span></a>
|
|
54
|
+
<a href="ServerlessProjectOptions.html#cdkDependenciesAsDeps" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps?</span></a>
|
|
55
|
+
<a href="ServerlessProjectOptions.html#cdkTestDependencies" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Test<wbr/>Dependencies?</span></a>
|
|
56
|
+
<a href="ServerlessProjectOptions.html#cdkVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Version</span></a>
|
|
57
|
+
<a href="ServerlessProjectOptions.html#cdkVersionPinning" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Version<wbr/>Pinning?</span></a>
|
|
58
|
+
<a href="ServerlessProjectOptions.html#cdkout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdkout?</span></a>
|
|
59
|
+
<a href="ServerlessProjectOptions.html#clobber" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>clobber?</span></a>
|
|
60
|
+
<a href="ServerlessProjectOptions.html#codeArtifactOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>code<wbr/>Artifact<wbr/>Options?</span></a>
|
|
61
|
+
<a href="ServerlessProjectOptions.html#codeCov" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>code<wbr/>Cov?</span></a>
|
|
62
|
+
<a href="ServerlessProjectOptions.html#codeCovTokenSecret" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret?</span></a>
|
|
63
|
+
<a href="ServerlessProjectOptions.html#commitGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>commit<wbr/>Generated?</span></a>
|
|
64
|
+
<a href="ServerlessProjectOptions.html#constructsVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>constructs<wbr/>Version?</span></a>
|
|
65
|
+
<a href="ServerlessProjectOptions.html#context" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>context?</span></a>
|
|
66
|
+
<a href="ServerlessProjectOptions.html#copyrightOwner" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>copyright<wbr/>Owner?</span></a>
|
|
67
|
+
<a href="ServerlessProjectOptions.html#copyrightPeriod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>copyright<wbr/>Period?</span></a>
|
|
68
|
+
<a href="ServerlessProjectOptions.html#defaultReleaseBranch" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a>
|
|
69
|
+
<a href="ServerlessProjectOptions.html#dependabot" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dependabot?</span></a>
|
|
70
|
+
<a href="ServerlessProjectOptions.html#dependabotOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dependabot<wbr/>Options?</span></a>
|
|
71
|
+
<a href="ServerlessProjectOptions.html#deps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>deps?</span></a>
|
|
72
|
+
<a href="ServerlessProjectOptions.html#depsUpgrade" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>deps<wbr/>Upgrade?</span></a>
|
|
73
|
+
<a href="ServerlessProjectOptions.html#depsUpgradeOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>deps<wbr/>Upgrade<wbr/>Options?</span></a>
|
|
74
|
+
<a href="ServerlessProjectOptions.html#description" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>description?</span></a>
|
|
75
|
+
<a href="ServerlessProjectOptions.html#devContainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dev<wbr/>Container?</span></a>
|
|
76
|
+
<a href="ServerlessProjectOptions.html#devDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dev<wbr/>Deps?</span></a>
|
|
77
|
+
<a href="ServerlessProjectOptions.html#disableTsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>disable<wbr/>Tsconfig?</span></a>
|
|
78
|
+
<a href="ServerlessProjectOptions.html#disableTsconfigDev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev?</span></a>
|
|
79
|
+
<a href="ServerlessProjectOptions.html#docgen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>docgen?</span></a>
|
|
80
|
+
<a href="ServerlessProjectOptions.html#docsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>docs<wbr/>Directory?</span></a>
|
|
81
|
+
<a href="ServerlessProjectOptions.html#edgeLambdaAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover?</span></a>
|
|
82
|
+
<a href="ServerlessProjectOptions.html#entrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>entrypoint?</span></a>
|
|
83
|
+
<a href="ServerlessProjectOptions.html#entrypointTypes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>entrypoint<wbr/>Types?</span></a>
|
|
84
|
+
<a href="ServerlessProjectOptions.html#eslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>eslint?</span></a>
|
|
85
|
+
<a href="ServerlessProjectOptions.html#eslintOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>eslint<wbr/>Options?</span></a>
|
|
86
|
+
<a href="ServerlessProjectOptions.html#featureFlags" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>feature<wbr/>Flags?</span></a>
|
|
87
|
+
<a href="ServerlessProjectOptions.html#gitIgnoreOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>git<wbr/>Ignore<wbr/>Options?</span></a>
|
|
88
|
+
<a href="ServerlessProjectOptions.html#gitOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>git<wbr/>Options?</span></a>
|
|
89
|
+
<a href="ServerlessProjectOptions.html#github" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>github?</span></a>
|
|
90
|
+
<a href="ServerlessProjectOptions.html#githubOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>github<wbr/>Options?</span></a>
|
|
91
|
+
<a href="ServerlessProjectOptions.html#gitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>gitignore?</span></a>
|
|
92
|
+
<a href="ServerlessProjectOptions.html#gitpod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>gitpod?</span></a>
|
|
93
|
+
<a href="ServerlessProjectOptions.html#homepage" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>homepage?</span></a>
|
|
94
|
+
<a href="ServerlessProjectOptions.html#integrationTestAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover?</span></a>
|
|
95
|
+
<a href="ServerlessProjectOptions.html#jest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>jest?</span></a>
|
|
96
|
+
<a href="ServerlessProjectOptions.html#jestOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>jest<wbr/>Options?</span></a>
|
|
97
|
+
<a href="ServerlessProjectOptions.html#jsiiReleaseVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>jsii<wbr/>Release<wbr/>Version?</span></a>
|
|
98
|
+
<a href="ServerlessProjectOptions.html#keywords" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>keywords?</span></a>
|
|
99
|
+
<a href="ServerlessProjectOptions.html#lambdaAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>lambda<wbr/>Auto<wbr/>Discover?</span></a>
|
|
100
|
+
<a href="ServerlessProjectOptions.html#lambdaExtensionAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover?</span></a>
|
|
101
|
+
<a href="ServerlessProjectOptions.html#lambdaOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>lambda<wbr/>Options?</span></a>
|
|
102
|
+
<a href="ServerlessProjectOptions.html#libdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>libdir?</span></a>
|
|
103
|
+
<a href="ServerlessProjectOptions.html#license" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>license?</span></a>
|
|
104
|
+
<a href="ServerlessProjectOptions.html#licensed" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>licensed?</span></a>
|
|
105
|
+
<a href="ServerlessProjectOptions.html#logging" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>logging?</span></a>
|
|
106
|
+
<a href="ServerlessProjectOptions.html#majorVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>major<wbr/>Version?</span></a>
|
|
107
|
+
<a href="ServerlessProjectOptions.html#maxNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>Node<wbr/>Version?</span></a>
|
|
108
|
+
<a href="ServerlessProjectOptions.html#mergify" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mergify?</span></a>
|
|
109
|
+
<a href="ServerlessProjectOptions.html#mergifyOptions" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mergify<wbr/>Options?</span></a>
|
|
110
|
+
<a href="ServerlessProjectOptions.html#minMajorVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>min<wbr/>Major<wbr/>Version?</span></a>
|
|
111
|
+
<a href="ServerlessProjectOptions.html#minNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>min<wbr/>Node<wbr/>Version?</span></a>
|
|
112
|
+
<a href="ServerlessProjectOptions.html#mutableBuild" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mutable<wbr/>Build?</span></a>
|
|
113
|
+
<a href="ServerlessProjectOptions.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
|
|
114
|
+
<a href="ServerlessProjectOptions.html#npmAccess" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Access?</span></a>
|
|
115
|
+
<a href="ServerlessProjectOptions.html#npmDistTag" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Dist<wbr/>Tag?</span></a>
|
|
116
|
+
<a href="ServerlessProjectOptions.html#npmIgnoreOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Ignore<wbr/>Options?</span></a>
|
|
117
|
+
<a href="ServerlessProjectOptions.html#npmRegistry" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Registry?</span></a>
|
|
118
|
+
<a href="ServerlessProjectOptions.html#npmRegistryUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Registry<wbr/>Url?</span></a>
|
|
119
|
+
<a href="ServerlessProjectOptions.html#npmTokenSecret" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Token<wbr/>Secret?</span></a>
|
|
120
|
+
<a href="ServerlessProjectOptions.html#npmignore" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npmignore?</span></a>
|
|
121
|
+
<a href="ServerlessProjectOptions.html#npmignoreEnabled" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npmignore<wbr/>Enabled?</span></a>
|
|
122
|
+
<a href="ServerlessProjectOptions.html#outdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>outdir?</span></a>
|
|
123
|
+
<a href="ServerlessProjectOptions.html#package" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>package?</span></a>
|
|
124
|
+
<a href="ServerlessProjectOptions.html#packageManager" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>package<wbr/>Manager?</span></a>
|
|
125
|
+
<a href="ServerlessProjectOptions.html#packageName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>package<wbr/>Name?</span></a>
|
|
126
|
+
<a href="ServerlessProjectOptions.html#parent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>parent?</span></a>
|
|
127
|
+
<a href="ServerlessProjectOptions.html#peerDependencyOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>peer<wbr/>Dependency<wbr/>Options?</span></a>
|
|
128
|
+
<a href="ServerlessProjectOptions.html#peerDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>peer<wbr/>Deps?</span></a>
|
|
129
|
+
<a href="ServerlessProjectOptions.html#pnpmVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pnpm<wbr/>Version?</span></a>
|
|
130
|
+
<a href="ServerlessProjectOptions.html#postBuildSteps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>post<wbr/>Build<wbr/>Steps?</span></a>
|
|
131
|
+
<a href="ServerlessProjectOptions.html#prerelease" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prerelease?</span></a>
|
|
132
|
+
<a href="ServerlessProjectOptions.html#prettier" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prettier?</span></a>
|
|
133
|
+
<a href="ServerlessProjectOptions.html#prettierOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prettier<wbr/>Options?</span></a>
|
|
134
|
+
<a href="ServerlessProjectOptions.html#projectType" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>project<wbr/>Type?</span></a>
|
|
135
|
+
<a href="ServerlessProjectOptions.html#projenCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Command?</span></a>
|
|
136
|
+
<a href="ServerlessProjectOptions.html#projenCredentials" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Credentials?</span></a>
|
|
137
|
+
<a href="ServerlessProjectOptions.html#projenDevDependency" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Dev<wbr/>Dependency?</span></a>
|
|
138
|
+
<a href="ServerlessProjectOptions.html#projenTokenSecret" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Token<wbr/>Secret?</span></a>
|
|
139
|
+
<a href="ServerlessProjectOptions.html#projenVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Version?</span></a>
|
|
140
|
+
<a href="ServerlessProjectOptions.html#projenrcJs" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Js?</span></a>
|
|
141
|
+
<a href="ServerlessProjectOptions.html#projenrcJsOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Js<wbr/>Options?</span></a>
|
|
142
|
+
<a href="ServerlessProjectOptions.html#projenrcJson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Json?</span></a>
|
|
143
|
+
<a href="ServerlessProjectOptions.html#projenrcJsonOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Json<wbr/>Options?</span></a>
|
|
144
|
+
<a href="ServerlessProjectOptions.html#projenrcTs" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Ts?</span></a>
|
|
145
|
+
<a href="ServerlessProjectOptions.html#projenrcTsOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options?</span></a>
|
|
146
|
+
<a href="ServerlessProjectOptions.html#publishDryRun" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>publish<wbr/>Dry<wbr/>Run?</span></a>
|
|
147
|
+
<a href="ServerlessProjectOptions.html#publishTasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>publish<wbr/>Tasks?</span></a>
|
|
148
|
+
<a href="ServerlessProjectOptions.html#pullRequestTemplate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pull<wbr/>Request<wbr/>Template?</span></a>
|
|
149
|
+
<a href="ServerlessProjectOptions.html#pullRequestTemplateContents" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents?</span></a>
|
|
150
|
+
<a href="ServerlessProjectOptions.html#readme" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>readme?</span></a>
|
|
151
|
+
<a href="ServerlessProjectOptions.html#release" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release?</span></a>
|
|
152
|
+
<a href="ServerlessProjectOptions.html#releaseBranches" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Branches?</span></a>
|
|
153
|
+
<a href="ServerlessProjectOptions.html#releaseEveryCommit" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Every<wbr/>Commit?</span></a>
|
|
154
|
+
<a href="ServerlessProjectOptions.html#releaseFailureIssue" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Failure<wbr/>Issue?</span></a>
|
|
155
|
+
<a href="ServerlessProjectOptions.html#releaseFailureIssueLabel" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label?</span></a>
|
|
156
|
+
<a href="ServerlessProjectOptions.html#releaseSchedule" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Schedule?</span></a>
|
|
157
|
+
<a href="ServerlessProjectOptions.html#releaseTagPrefix" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Tag<wbr/>Prefix?</span></a>
|
|
158
|
+
<a href="ServerlessProjectOptions.html#releaseToNpm" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>To<wbr/>Npm?</span></a>
|
|
159
|
+
<a href="ServerlessProjectOptions.html#releaseTrigger" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Trigger?</span></a>
|
|
160
|
+
<a href="ServerlessProjectOptions.html#releaseWorkflow" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Workflow?</span></a>
|
|
161
|
+
<a href="ServerlessProjectOptions.html#releaseWorkflowName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Workflow<wbr/>Name?</span></a>
|
|
162
|
+
<a href="ServerlessProjectOptions.html#releaseWorkflowSetupSteps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps?</span></a>
|
|
163
|
+
<a href="ServerlessProjectOptions.html#renovatebot" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>renovatebot?</span></a>
|
|
164
|
+
<a href="ServerlessProjectOptions.html#renovatebotOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>renovatebot<wbr/>Options?</span></a>
|
|
165
|
+
<a href="ServerlessProjectOptions.html#repository" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>repository?</span></a>
|
|
166
|
+
<a href="ServerlessProjectOptions.html#repositoryDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>repository<wbr/>Directory?</span></a>
|
|
167
|
+
<a href="ServerlessProjectOptions.html#requireApproval" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>require<wbr/>Approval?</span></a>
|
|
168
|
+
<a href="ServerlessProjectOptions.html#sampleCode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>sample<wbr/>Code?</span></a>
|
|
169
|
+
<a href="ServerlessProjectOptions.html#scopedPackagesOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>scoped<wbr/>Packages<wbr/>Options?</span></a>
|
|
170
|
+
<a href="ServerlessProjectOptions.html#scripts" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>scripts?</span></a>
|
|
171
|
+
<a href="ServerlessProjectOptions.html#srcdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>srcdir?</span></a>
|
|
172
|
+
<a href="ServerlessProjectOptions.html#stability" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stability?</span></a>
|
|
173
|
+
<a href="ServerlessProjectOptions.html#stale" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stale?</span></a>
|
|
174
|
+
<a href="ServerlessProjectOptions.html#staleOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stale<wbr/>Options?</span></a>
|
|
175
|
+
<a href="ServerlessProjectOptions.html#testdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>testdir?</span></a>
|
|
176
|
+
<a href="ServerlessProjectOptions.html#tsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tsconfig?</span></a>
|
|
177
|
+
<a href="ServerlessProjectOptions.html#tsconfigDev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tsconfig<wbr/>Dev?</span></a>
|
|
178
|
+
<a href="ServerlessProjectOptions.html#tsconfigDevFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tsconfig<wbr/>Dev<wbr/>File?</span></a>
|
|
179
|
+
<a href="ServerlessProjectOptions.html#typescriptVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>typescript<wbr/>Version?</span></a>
|
|
180
|
+
<a href="ServerlessProjectOptions.html#versionrcOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>versionrc<wbr/>Options?</span></a>
|
|
181
|
+
<a href="ServerlessProjectOptions.html#vscode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>vscode?</span></a>
|
|
182
|
+
<a href="ServerlessProjectOptions.html#watchExcludes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>watch<wbr/>Excludes?</span></a>
|
|
183
|
+
<a href="ServerlessProjectOptions.html#watchIncludes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>watch<wbr/>Includes?</span></a>
|
|
184
|
+
<a href="ServerlessProjectOptions.html#workflowBootstrapSteps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps?</span></a>
|
|
185
|
+
<a href="ServerlessProjectOptions.html#workflowContainerImage" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Container<wbr/>Image?</span></a>
|
|
186
|
+
<a href="ServerlessProjectOptions.html#workflowGitIdentity" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Git<wbr/>Identity?</span></a>
|
|
187
|
+
<a href="ServerlessProjectOptions.html#workflowNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Node<wbr/>Version?</span></a>
|
|
188
|
+
<a href="ServerlessProjectOptions.html#workflowRunsOn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Runs<wbr/>On?</span></a>
|
|
189
|
+
</div></section></div></details></section></section>
|
|
190
|
+
<section class="tsd-panel-group tsd-member-group">
|
|
191
|
+
<h2>Properties</h2>
|
|
192
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowLibraryDependencies" class="tsd-anchor"></a>
|
|
193
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowLibraryDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
|
194
|
+
<div class="tsd-signature"><span class="tsd-kind-property">allow<wbr/>Library<wbr/>Dependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
195
|
+
<div class="tsd-comment tsd-typography"><p>Allow the project to include <code>peerDependencies</code> and <code>bundledDependencies</code>.
|
|
196
|
+
This is normally only allowed for libraries. For apps, there's no meaning
|
|
197
|
+
for specifying these.</p>
|
|
198
|
+
|
|
199
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
200
|
+
</code></pre>
|
|
201
|
+
</div><aside class="tsd-sources">
|
|
202
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.allowLibraryDependencies</p></aside></section>
|
|
203
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appEntrypoint" class="tsd-anchor"></a>
|
|
204
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>app<wbr/>Entrypoint</span><a href="#appEntrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
205
|
+
<div class="tsd-signature"><span class="tsd-kind-property">app<wbr/>Entrypoint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
206
|
+
<div class="tsd-comment tsd-typography"><p>The CDK app's entrypoint (relative to the source directory, which is
|
|
207
|
+
"src" by default).</p>
|
|
208
|
+
|
|
209
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"main.ts"</span>
|
|
210
|
+
</code></pre>
|
|
211
|
+
</div><aside class="tsd-sources">
|
|
212
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.appEntrypoint</p></aside></section>
|
|
213
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsDirectory" class="tsd-anchor"></a>
|
|
214
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Directory</span><a href="#artifactsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
215
|
+
<div class="tsd-signature"><span class="tsd-kind-property">artifacts<wbr/>Directory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
216
|
+
<div class="tsd-comment tsd-typography"><p>A directory which will contain build artifacts.</p>
|
|
217
|
+
|
|
218
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"dist"</span>
|
|
219
|
+
</code></pre>
|
|
220
|
+
</div><aside class="tsd-sources">
|
|
221
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.artifactsDirectory</p></aside></section>
|
|
222
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorEmail" class="tsd-anchor"></a>
|
|
223
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Email</span><a href="#authorEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
224
|
+
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Email</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
225
|
+
<div class="tsd-comment tsd-typography"><p>Author's e-mail</p>
|
|
226
|
+
</div><aside class="tsd-sources">
|
|
227
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorEmail</p></aside></section>
|
|
228
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorName" class="tsd-anchor"></a>
|
|
229
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Name</span><a href="#authorName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
230
|
+
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
231
|
+
<div class="tsd-comment tsd-typography"><p>Author's name</p>
|
|
232
|
+
</div><aside class="tsd-sources">
|
|
233
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorName</p></aside></section>
|
|
234
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorOrganization" class="tsd-anchor"></a>
|
|
235
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Organization</span><a href="#authorOrganization" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
236
|
+
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Organization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
237
|
+
<div class="tsd-comment tsd-typography"><p>Is the author an organization</p>
|
|
238
|
+
</div><aside class="tsd-sources">
|
|
239
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorOrganization</p></aside></section>
|
|
240
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorUrl" class="tsd-anchor"></a>
|
|
241
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Url</span><a href="#authorUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
242
|
+
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
243
|
+
<div class="tsd-comment tsd-typography"><p>Author's URL / Website</p>
|
|
244
|
+
</div><aside class="tsd-sources">
|
|
245
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorUrl</p></aside></section>
|
|
246
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveOptions" class="tsd-anchor"></a>
|
|
247
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Approve<wbr/>Options</span><a href="#autoApproveOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
248
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Approve<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoApproveOptions</span></div>
|
|
249
|
+
<div class="tsd-comment tsd-typography"><p>Enable and configure the 'auto approve' workflow.</p>
|
|
250
|
+
|
|
251
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">auto</span><span class="hl-0"> </span><span class="hl-3">approve</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">disabled</span>
|
|
252
|
+
</code></pre>
|
|
253
|
+
</div><aside class="tsd-sources">
|
|
254
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveOptions</p></aside></section>
|
|
255
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveUpgrades" class="tsd-anchor"></a>
|
|
256
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Approve<wbr/>Upgrades</span><a href="#autoApproveUpgrades" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
257
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Approve<wbr/>Upgrades</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
258
|
+
<div class="tsd-comment tsd-typography"><p>Automatically approve deps upgrade PRs, allowing them to be
|
|
259
|
+
merged by mergify (if configued).</p>
|
|
260
|
+
<p>Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
|
|
261
|
+
|
|
262
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span>
|
|
263
|
+
</code></pre>
|
|
264
|
+
</div><aside class="tsd-sources">
|
|
265
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveUpgrades</p></aside></section>
|
|
266
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoDetectBin" class="tsd-anchor"></a>
|
|
267
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Detect<wbr/>Bin</span><a href="#autoDetectBin" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
268
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Detect<wbr/>Bin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
269
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add all executables under the <code>bin</code> directory to your
|
|
270
|
+
<code>package.json</code> file under the <code>bin</code> section.</p>
|
|
271
|
+
|
|
272
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
273
|
+
</code></pre>
|
|
274
|
+
</div><aside class="tsd-sources">
|
|
275
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoDetectBin</p></aside></section>
|
|
276
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMerge" class="tsd-anchor"></a>
|
|
277
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Merge</span><a href="#autoMerge" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
278
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Merge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
279
|
+
<div class="tsd-comment tsd-typography"><p>Enable automatic merging on GitHub. Has no effect if <code>github.mergify</code>
|
|
280
|
+
is set to false.</p>
|
|
281
|
+
|
|
282
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
283
|
+
</code></pre>
|
|
284
|
+
</div><aside class="tsd-sources">
|
|
285
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMerge</p></aside></section>
|
|
286
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMergeOptions" class="tsd-anchor"></a>
|
|
287
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Merge<wbr/>Options</span><a href="#autoMergeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
288
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Merge<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoMergeOptions</span></div>
|
|
289
|
+
<div class="tsd-comment tsd-typography"><p>Configure options for automatic merging on GitHub. Has no effect if
|
|
290
|
+
<code>github.mergify</code> or <code>autoMerge</code> is set to false.</p>
|
|
291
|
+
|
|
292
|
+
<h3>Default</h3><ul>
|
|
293
|
+
<li>see defaults in <code>AutoMergeOptions</code></li>
|
|
294
|
+
</ul>
|
|
295
|
+
</div><aside class="tsd-sources">
|
|
296
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMergeOptions</p></aside></section>
|
|
297
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bin" class="tsd-anchor"></a>
|
|
298
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bin</span><a href="#bin" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
299
|
+
<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>
|
|
300
|
+
<div class="tsd-comment tsd-typography"><p>Binary programs vended with your module.</p>
|
|
301
|
+
<p>You can use this option to add/customize how binaries are represented in
|
|
302
|
+
your <code>package.json</code>, but unless <code>autoDetectBin</code> is <code>false</code>, every
|
|
303
|
+
executable file under <code>bin</code> will automatically be added to this section.</p>
|
|
304
|
+
</div><aside class="tsd-sources">
|
|
305
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bin</p></aside></section>
|
|
306
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bugsEmail" class="tsd-anchor"></a>
|
|
307
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bugs<wbr/>Email</span><a href="#bugsEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
308
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bugs<wbr/>Email</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
309
|
+
<div class="tsd-comment tsd-typography"><p>The email address to which issues should be reported.</p>
|
|
310
|
+
</div><aside class="tsd-sources">
|
|
311
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsEmail</p></aside></section>
|
|
312
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bugsUrl" class="tsd-anchor"></a>
|
|
313
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bugs<wbr/>Url</span><a href="#bugsUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
314
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bugs<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
315
|
+
<div class="tsd-comment tsd-typography"><p>The url to your project's issue tracker.</p>
|
|
316
|
+
</div><aside class="tsd-sources">
|
|
317
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsUrl</p></aside></section>
|
|
318
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildCommand" class="tsd-anchor"></a>
|
|
319
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Command</span><a href="#buildCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
320
|
+
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Command</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
321
|
+
<div class="tsd-comment tsd-typography"><p>A command to execute before synthesis. This command will be called when
|
|
322
|
+
running <code>cdk synth</code> or when <code>cdk watch</code> identifies a change in your source
|
|
323
|
+
code before redeployment.</p>
|
|
324
|
+
|
|
325
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">build</span><span class="hl-0"> </span><span class="hl-3">command</span>
|
|
326
|
+
</code></pre>
|
|
327
|
+
</div><aside class="tsd-sources">
|
|
328
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildCommand</p></aside></section>
|
|
329
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflow" class="tsd-anchor"></a>
|
|
330
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Workflow</span><a href="#buildWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
331
|
+
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
332
|
+
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
|
|
333
|
+
|
|
334
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> </span><span class="hl-3">subproject</span>
|
|
335
|
+
</code></pre>
|
|
336
|
+
</div><aside class="tsd-sources">
|
|
337
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflow</p></aside></section>
|
|
338
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflowTriggers" class="tsd-anchor"></a>
|
|
339
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Workflow<wbr/>Triggers</span><a href="#buildWorkflowTriggers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
340
|
+
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Workflow<wbr/>Triggers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Triggers</span></div>
|
|
341
|
+
<div class="tsd-comment tsd-typography"><p>Build workflow triggers</p>
|
|
342
|
+
|
|
343
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"{ pullRequest: {}, workflowDispatch: {} }"</span>
|
|
344
|
+
</code></pre>
|
|
345
|
+
</div><aside class="tsd-sources">
|
|
346
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflowTriggers</p></aside></section>
|
|
347
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundledDeps" class="tsd-anchor"></a>
|
|
348
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundled<wbr/>Deps</span><a href="#bundledDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
349
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bundled<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
350
|
+
<div class="tsd-comment tsd-typography"><p>List of dependencies to bundle into this module. These modules will be
|
|
351
|
+
added both to the <code>dependencies</code> section and <code>bundledDependencies</code> section of
|
|
352
|
+
your <code>package.json</code>.</p>
|
|
353
|
+
<p>The recommendation is to only specify the module name here (e.g.
|
|
354
|
+
<code>express</code>). This will behave similar to <code>yarn add</code> or <code>npm install</code> in the
|
|
355
|
+
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
356
|
+
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
357
|
+
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
358
|
+
this will be what you <code>package.json</code> will eventually include.</p>
|
|
359
|
+
</div><aside class="tsd-sources">
|
|
360
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundledDeps</p></aside></section>
|
|
361
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundlerOptions" class="tsd-anchor"></a>
|
|
362
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundler<wbr/>Options</span><a href="#bundlerOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
363
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bundler<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">BundlerOptions</span></div>
|
|
364
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>Bundler</code>.</p>
|
|
365
|
+
</div><aside class="tsd-sources">
|
|
366
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundlerOptions</p></aside></section>
|
|
367
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkAssert" class="tsd-anchor"></a>
|
|
368
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Assert</span><a href="#cdkAssert" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
369
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Assert</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
370
|
+
<div class="tsd-comment tsd-typography"><p>Warning: NodeJS only.
|
|
371
|
+
Install the @aws-cdk/assert library?</p>
|
|
372
|
+
|
|
373
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">will</span><span class="hl-0"> </span><span class="hl-3">be</span><span class="hl-0"> </span><span class="hl-3">included</span><span class="hl-0"> </span><span class="hl-3">by</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">AWS</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> >= </span><span class="hl-6">1.0</span><span class="hl-0">.</span><span class="hl-6">0</span><span class="hl-0"> < </span><span class="hl-6">2.0</span><span class="hl-0">.</span><span class="hl-6">0</span>
|
|
374
|
+
</code></pre>
|
|
375
|
+
|
|
376
|
+
<h3>Deprecated</h3><p>The @aws-cdk/assert library is deprecated in favor of
|
|
377
|
+
@aws-cdk/assertions (in V1) and included in <code>aws-cdk-lib</code> for V2.</p>
|
|
378
|
+
</div><aside class="tsd-sources">
|
|
379
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssert</p></aside></section>
|
|
380
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkAssertions" class="tsd-anchor"></a>
|
|
381
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Assertions</span><a href="#cdkAssertions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
382
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Assertions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
383
|
+
<div class="tsd-comment tsd-typography"><p>Install the assertions library?</p>
|
|
384
|
+
<p>Only needed for CDK 1.x. If using CDK 2.x then
|
|
385
|
+
assertions is already included in 'aws-cdk-lib'</p>
|
|
386
|
+
|
|
387
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">will</span><span class="hl-0"> </span><span class="hl-3">be</span><span class="hl-0"> </span><span class="hl-3">included</span><span class="hl-0"> </span><span class="hl-3">by</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">AWS</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> >= </span><span class="hl-6">1.111</span><span class="hl-0">.</span><span class="hl-6">0</span><span class="hl-0"> < </span><span class="hl-6">2.0</span><span class="hl-0">.</span><span class="hl-6">0</span>
|
|
388
|
+
</code></pre>
|
|
389
|
+
</div><aside class="tsd-sources">
|
|
390
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssertions</p></aside></section>
|
|
391
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependencies" class="tsd-anchor"></a>
|
|
392
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Dependencies</span><a href="#cdkDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
393
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Dependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
394
|
+
<div class="tsd-comment tsd-typography"><p>Which AWS CDKv1 modules this project requires</p>
|
|
395
|
+
|
|
396
|
+
<h3>Deprecated</h3><p>For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)</p>
|
|
397
|
+
</div><aside class="tsd-sources">
|
|
398
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependencies</p></aside></section>
|
|
399
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependenciesAsDeps" class="tsd-anchor"></a>
|
|
400
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span><a href="#cdkDependenciesAsDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
401
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
402
|
+
<div class="tsd-comment tsd-typography"><p>If this is enabled (default), all modules declared in <code>cdkDependencies</code> will be also added as
|
|
403
|
+
normal <code>dependencies</code> (as well as <code>peerDependencies</code>).</p>
|
|
404
|
+
<p>This is to ensure that downstream consumers actually have your CDK dependencies installed
|
|
405
|
+
when using npm < 7 or yarn, where peer dependencies are not automatically installed.
|
|
406
|
+
If this is disabled, <code>cdkDependencies</code> will be added to <code>devDependencies</code> to ensure
|
|
407
|
+
they are present during development.</p>
|
|
408
|
+
<p>Note: this setting only applies to construct library projects</p>
|
|
409
|
+
|
|
410
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
411
|
+
</code></pre>
|
|
412
|
+
|
|
413
|
+
<h3>Deprecated</h3><p>Not supported in CDK v2.</p>
|
|
414
|
+
</div><aside class="tsd-sources">
|
|
415
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependenciesAsDeps</p></aside></section>
|
|
416
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkTestDependencies" class="tsd-anchor"></a>
|
|
417
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Test<wbr/>Dependencies</span><a href="#cdkTestDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
418
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Test<wbr/>Dependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
419
|
+
<div class="tsd-comment tsd-typography"><p>AWS CDK modules required for testing.</p>
|
|
420
|
+
|
|
421
|
+
<h3>Deprecated</h3><p>For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead</p>
|
|
422
|
+
</div><aside class="tsd-sources">
|
|
423
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkTestDependencies</p></aside></section>
|
|
424
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersion" class="tsd-anchor"></a>
|
|
425
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Version</span><a href="#cdkVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
426
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
427
|
+
<div class="tsd-comment tsd-typography"><p>Minimum version of the AWS CDK to depend on.</p>
|
|
428
|
+
|
|
429
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"2.1.0"</span>
|
|
430
|
+
</code></pre>
|
|
431
|
+
</div><aside class="tsd-sources">
|
|
432
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersion</p></aside></section>
|
|
433
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersionPinning" class="tsd-anchor"></a>
|
|
434
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Version<wbr/>Pinning</span><a href="#cdkVersionPinning" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
435
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Version<wbr/>Pinning</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
436
|
+
<div class="tsd-comment tsd-typography"><p>Use pinned version instead of caret version for CDK.</p>
|
|
437
|
+
<p>You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
|
|
438
|
+
If you use experimental features this will let you define the moment you include breaking changes.</p>
|
|
439
|
+
</div><aside class="tsd-sources">
|
|
440
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersionPinning</p></aside></section>
|
|
441
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkout" class="tsd-anchor"></a>
|
|
442
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdkout</span><a href="#cdkout" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
443
|
+
<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>
|
|
444
|
+
<div class="tsd-comment tsd-typography"><p>cdk.out directory.</p>
|
|
445
|
+
|
|
446
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"cdk.out"</span>
|
|
447
|
+
</code></pre>
|
|
448
|
+
</div><aside class="tsd-sources">
|
|
449
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkout</p></aside></section>
|
|
450
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clobber" class="tsd-anchor"></a>
|
|
451
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>clobber</span><a href="#clobber" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
452
|
+
<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>
|
|
453
|
+
<div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
|
|
454
|
+
|
|
455
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0">, </span><span class="hl-3">but</span><span class="hl-0"> </span><span class="hl-2">false</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-3">subprojects</span>
|
|
456
|
+
</code></pre>
|
|
457
|
+
</div><aside class="tsd-sources">
|
|
458
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.clobber</p></aside></section>
|
|
459
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeArtifactOptions" class="tsd-anchor"></a>
|
|
460
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Artifact<wbr/>Options</span><a href="#codeArtifactOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
461
|
+
<div class="tsd-signature"><span class="tsd-kind-property">code<wbr/>Artifact<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">CodeArtifactOptions</span></div>
|
|
462
|
+
<div class="tsd-comment tsd-typography"><p>Options for npm packages using AWS CodeArtifact.
|
|
463
|
+
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
|
|
464
|
+
|
|
465
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">undefined</span>
|
|
466
|
+
</code></pre>
|
|
467
|
+
</div><aside class="tsd-sources">
|
|
468
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeArtifactOptions</p></aside></section>
|
|
469
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCov" class="tsd-anchor"></a>
|
|
470
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Cov</span><a href="#codeCov" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
471
|
+
<div class="tsd-signature"><span class="tsd-kind-property">code<wbr/>Cov</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
472
|
+
<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>
|
|
473
|
+
Uses codecov/codecov-action@v3
|
|
474
|
+
A secret is required for private repos. Configured with</p>
|
|
475
|
+
|
|
476
|
+
<h3>Code Cov Token Secret</h3>
|
|
477
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
478
|
+
</code></pre>
|
|
479
|
+
</div><aside class="tsd-sources">
|
|
480
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCov</p></aside></section>
|
|
481
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCovTokenSecret" class="tsd-anchor"></a>
|
|
482
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><a href="#codeCovTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
483
|
+
<div class="tsd-signature"><span class="tsd-kind-property">code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
484
|
+
<div class="tsd-comment tsd-typography"><p>Define the secret name for a specified <a href="https://codecov.io/">https://codecov.io/</a> token
|
|
485
|
+
A secret is required to send coverage for private repositories</p>
|
|
486
|
+
|
|
487
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-2">this</span><span class="hl-0"> </span><span class="hl-3">option</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">specified</span><span class="hl-0">, </span><span class="hl-3">only</span><span class="hl-0"> </span><span class="hl-3">public</span><span class="hl-0"> </span><span class="hl-3">repositories</span><span class="hl-0"> </span><span class="hl-3">are</span><span class="hl-0"> </span><span class="hl-3">supported</span>
|
|
488
|
+
</code></pre>
|
|
489
|
+
</div><aside class="tsd-sources">
|
|
490
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCovTokenSecret</p></aside></section>
|
|
491
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitGenerated" class="tsd-anchor"></a>
|
|
492
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>commit<wbr/>Generated</span><a href="#commitGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
493
|
+
<div class="tsd-signature"><span class="tsd-kind-property">commit<wbr/>Generated</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
494
|
+
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
495
|
+
|
|
496
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
497
|
+
</code></pre>
|
|
498
|
+
</div><aside class="tsd-sources">
|
|
499
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.commitGenerated</p></aside></section>
|
|
500
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="constructsVersion" class="tsd-anchor"></a>
|
|
501
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>constructs<wbr/>Version</span><a href="#constructsVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
502
|
+
<div class="tsd-signature"><span class="tsd-kind-property">constructs<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
503
|
+
<div class="tsd-comment tsd-typography"><p>Minimum version of the <code>constructs</code> library to depend on.</p>
|
|
504
|
+
|
|
505
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> 1.</span><span class="hl-3">x</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-1">"3.2.27"</span><span class="hl-0">, </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> 2.</span><span class="hl-3">x</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">is</span><br/><span class="hl-1">"10.0.5"</span><span class="hl-0">.</span>
|
|
506
|
+
</code></pre>
|
|
507
|
+
</div><aside class="tsd-sources">
|
|
508
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.constructsVersion</p></aside></section>
|
|
509
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="context" class="tsd-anchor"></a>
|
|
510
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
511
|
+
<div class="tsd-signature"><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</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><br/><span class="tsd-signature-symbol">}</span></div>
|
|
512
|
+
<div class="tsd-comment tsd-typography"><p>Additional context to include in <code>cdk.json</code>.</p>
|
|
513
|
+
|
|
514
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">additional</span><span class="hl-0"> </span><span class="hl-3">context</span>
|
|
515
|
+
</code></pre>
|
|
516
|
+
</div>
|
|
517
|
+
<div class="tsd-type-declaration">
|
|
518
|
+
<h4>Type declaration</h4>
|
|
519
|
+
<ul class="tsd-parameters">
|
|
520
|
+
<li class="tsd-parameter-index-signature">
|
|
521
|
+
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></div><aside class="tsd-sources">
|
|
522
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.context</p></aside></section>
|
|
523
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyrightOwner" class="tsd-anchor"></a>
|
|
524
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>copyright<wbr/>Owner</span><a href="#copyrightOwner" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
525
|
+
<div class="tsd-signature"><span class="tsd-kind-property">copyright<wbr/>Owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
526
|
+
<div class="tsd-comment tsd-typography"><p>License copyright owner.</p>
|
|
527
|
+
|
|
528
|
+
<h3>Default</h3><ul>
|
|
529
|
+
<li>defaults to the value of authorName or "" if <code>authorName</code> is undefined.</li>
|
|
530
|
+
</ul>
|
|
531
|
+
</div><aside class="tsd-sources">
|
|
532
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightOwner</p></aside></section>
|
|
533
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyrightPeriod" class="tsd-anchor"></a>
|
|
534
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>copyright<wbr/>Period</span><a href="#copyrightPeriod" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
535
|
+
<div class="tsd-signature"><span class="tsd-kind-property">copyright<wbr/>Period</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
536
|
+
<div class="tsd-comment tsd-typography"><p>The copyright years to put in the LICENSE file.</p>
|
|
537
|
+
|
|
538
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">current</span><span class="hl-0"> </span><span class="hl-3">year</span>
|
|
539
|
+
</code></pre>
|
|
540
|
+
</div><aside class="tsd-sources">
|
|
541
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightPeriod</p></aside></section>
|
|
542
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultReleaseBranch" class="tsd-anchor"></a>
|
|
543
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>default<wbr/>Release<wbr/>Branch</span><a href="#defaultReleaseBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
544
|
+
<div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Release<wbr/>Branch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
545
|
+
<div class="tsd-comment tsd-typography"><p>The name of the main release branch.</p>
|
|
546
|
+
|
|
547
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"main"</span>
|
|
548
|
+
</code></pre>
|
|
549
|
+
</div><aside class="tsd-sources">
|
|
550
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.defaultReleaseBranch</p></aside></section>
|
|
551
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabot" class="tsd-anchor"></a>
|
|
552
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dependabot</span><a href="#dependabot" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
553
|
+
<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>
|
|
554
|
+
<div class="tsd-comment tsd-typography"><p>Use dependabot to handle dependency upgrades.
|
|
555
|
+
Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
556
|
+
|
|
557
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
558
|
+
</code></pre>
|
|
559
|
+
</div><aside class="tsd-sources">
|
|
560
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabot</p></aside></section>
|
|
561
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabotOptions" class="tsd-anchor"></a>
|
|
562
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dependabot<wbr/>Options</span><a href="#dependabotOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
563
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dependabot<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">DependabotOptions</span></div>
|
|
564
|
+
<div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
|
|
565
|
+
|
|
566
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
567
|
+
</code></pre>
|
|
568
|
+
</div><aside class="tsd-sources">
|
|
569
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabotOptions</p></aside></section>
|
|
570
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a>
|
|
571
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps</span><a href="#deps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
572
|
+
<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>
|
|
573
|
+
<div class="tsd-comment tsd-typography"><p>Runtime dependencies of this module.</p>
|
|
574
|
+
<p>The recommendation is to only specify the module name here (e.g.
|
|
575
|
+
<code>express</code>). This will behave similar to <code>yarn add</code> or <code>npm install</code> in the
|
|
576
|
+
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
577
|
+
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
578
|
+
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
579
|
+
this will be what you <code>package.json</code> will eventually include.</p>
|
|
580
|
+
|
|
581
|
+
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">[ </span><span class="hl-1">'express'</span><span class="hl-0">, </span><span class="hl-1">'lodash'</span><span class="hl-0">, </span><span class="hl-1">'foo@^2'</span><span class="hl-0"> ]</span>
|
|
582
|
+
</code></pre>
|
|
583
|
+
|
|
584
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
585
|
+
</code></pre>
|
|
586
|
+
|
|
587
|
+
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
588
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.deps</p></aside></section>
|
|
589
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgrade" class="tsd-anchor"></a>
|
|
590
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps<wbr/>Upgrade</span><a href="#depsUpgrade" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
591
|
+
<div class="tsd-signature"><span class="tsd-kind-property">deps<wbr/>Upgrade</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
592
|
+
<div class="tsd-comment tsd-typography"><p>Use github workflows to handle dependency upgrades.
|
|
593
|
+
Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
594
|
+
|
|
595
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
596
|
+
</code></pre>
|
|
597
|
+
</div><aside class="tsd-sources">
|
|
598
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgrade</p></aside></section>
|
|
599
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgradeOptions" class="tsd-anchor"></a>
|
|
600
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps<wbr/>Upgrade<wbr/>Options</span><a href="#depsUpgradeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
601
|
+
<div class="tsd-signature"><span class="tsd-kind-property">deps<wbr/>Upgrade<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">UpgradeDependenciesOptions</span></div>
|
|
602
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
|
|
603
|
+
|
|
604
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
605
|
+
</code></pre>
|
|
606
|
+
</div><aside class="tsd-sources">
|
|
607
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgradeOptions</p></aside></section>
|
|
608
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="description" class="tsd-anchor"></a>
|
|
609
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
610
|
+
<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>
|
|
611
|
+
<div class="tsd-comment tsd-typography"><p>The description is just a string that helps people understand the purpose of the package.
|
|
612
|
+
It can be used when searching for packages in a package manager as well.
|
|
613
|
+
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>
|
|
614
|
+
|
|
615
|
+
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
616
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.description</p></aside></section>
|
|
617
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devContainer" class="tsd-anchor"></a>
|
|
618
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Container</span><a href="#devContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
619
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dev<wbr/>Container</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
620
|
+
<div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces)</p>
|
|
621
|
+
|
|
622
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
623
|
+
</code></pre>
|
|
624
|
+
</div><aside class="tsd-sources">
|
|
625
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devContainer</p></aside></section>
|
|
626
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devDeps" class="tsd-anchor"></a>
|
|
627
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Deps</span><a href="#devDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
628
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dev<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
629
|
+
<div class="tsd-comment tsd-typography"><p>Build dependencies for this module. These dependencies will only be
|
|
630
|
+
available in your build environment but will not be fetched when this
|
|
631
|
+
module is consumed.</p>
|
|
632
|
+
<p>The recommendation is to only specify the module name here (e.g.
|
|
633
|
+
<code>express</code>). This will behave similar to <code>yarn add</code> or <code>npm install</code> in the
|
|
634
|
+
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
635
|
+
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
636
|
+
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
637
|
+
this will be what you <code>package.json</code> will eventually include.</p>
|
|
638
|
+
|
|
639
|
+
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">[ </span><span class="hl-1">'typescript'</span><span class="hl-0">, </span><span class="hl-1">'@types/express'</span><span class="hl-0"> ]</span>
|
|
640
|
+
</code></pre>
|
|
641
|
+
|
|
642
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
643
|
+
</code></pre>
|
|
644
|
+
|
|
645
|
+
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
646
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devDeps</p></aside></section>
|
|
647
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfig" class="tsd-anchor"></a>
|
|
648
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>disable<wbr/>Tsconfig</span><a href="#disableTsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
649
|
+
<div class="tsd-signature"><span class="tsd-kind-property">disable<wbr/>Tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
650
|
+
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.json</code> file (used by jsii projects since
|
|
651
|
+
tsconfig.json is generated by the jsii compiler).</p>
|
|
652
|
+
|
|
653
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
654
|
+
</code></pre>
|
|
655
|
+
</div><aside class="tsd-sources">
|
|
656
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfig</p></aside></section>
|
|
657
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfigDev" class="tsd-anchor"></a>
|
|
658
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>disable<wbr/>Tsconfig<wbr/>Dev</span><a href="#disableTsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
659
|
+
<div class="tsd-signature"><span class="tsd-kind-property">disable<wbr/>Tsconfig<wbr/>Dev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
660
|
+
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.dev.json</code> file.</p>
|
|
661
|
+
|
|
662
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
663
|
+
</code></pre>
|
|
664
|
+
</div><aside class="tsd-sources">
|
|
665
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfigDev</p></aside></section>
|
|
666
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a>
|
|
667
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docgen</span><a href="#docgen" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
668
|
+
<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>
|
|
669
|
+
<div class="tsd-comment tsd-typography"><p>Docgen by Typedoc</p>
|
|
670
|
+
|
|
671
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
672
|
+
</code></pre>
|
|
673
|
+
</div><aside class="tsd-sources">
|
|
674
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docgen</p></aside></section>
|
|
675
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsDirectory" class="tsd-anchor"></a>
|
|
676
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docs<wbr/>Directory</span><a href="#docsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
677
|
+
<div class="tsd-signature"><span class="tsd-kind-property">docs<wbr/>Directory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
678
|
+
<div class="tsd-comment tsd-typography"><p>Docs directory</p>
|
|
679
|
+
|
|
680
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"docs"</span>
|
|
681
|
+
</code></pre>
|
|
682
|
+
</div><aside class="tsd-sources">
|
|
683
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docsDirectory</p></aside></section>
|
|
684
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="edgeLambdaAutoDiscover" class="tsd-anchor"></a>
|
|
685
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><a href="#edgeLambdaAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
686
|
+
<div class="tsd-signature"><span class="tsd-kind-property">edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
687
|
+
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>cloudfront.experimental.EdgeFunction</code> for each
|
|
688
|
+
<code>.edge-lambda.ts</code> handler in your source tree. If this is disabled, you can
|
|
689
|
+
manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
690
|
+
|
|
691
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
692
|
+
</code></pre>
|
|
693
|
+
</div><aside class="tsd-sources">
|
|
694
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.edgeLambdaAutoDiscover</p></aside></section>
|
|
695
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" class="tsd-anchor"></a>
|
|
696
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entrypoint</span><a href="#entrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
697
|
+
<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>
|
|
698
|
+
<div class="tsd-comment tsd-typography"><p>Module entrypoint (<code>main</code> in <code>package.json</code>)</p>
|
|
699
|
+
<p>Set to an empty string to not include <code>main</code> in your package.json</p>
|
|
700
|
+
|
|
701
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"lib/index.js"</span>
|
|
702
|
+
</code></pre>
|
|
703
|
+
</div><aside class="tsd-sources">
|
|
704
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypoint</p></aside></section>
|
|
705
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypointTypes" class="tsd-anchor"></a>
|
|
706
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entrypoint<wbr/>Types</span><a href="#entrypointTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
707
|
+
<div class="tsd-signature"><span class="tsd-kind-property">entrypoint<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
708
|
+
<div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
|
|
709
|
+
|
|
710
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- .</span><span class="hl-3">d</span><span class="hl-0">.</span><span class="hl-3">ts</span><span class="hl-0"> </span><span class="hl-3">file</span><span class="hl-0"> </span><span class="hl-3">derived</span><span class="hl-0"> </span><span class="hl-3">from</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">project</span><span class="hl-1">'s entrypoint (usually lib/index.d.ts</span><span class="hl-7">)</span>
|
|
711
|
+
</code></pre>
|
|
712
|
+
</div><aside class="tsd-sources">
|
|
713
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypointTypes</p></aside></section>
|
|
714
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a>
|
|
715
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint</span><a href="#eslint" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
716
|
+
<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>
|
|
717
|
+
<div class="tsd-comment tsd-typography"><p>Setup eslint.</p>
|
|
718
|
+
|
|
719
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
720
|
+
</code></pre>
|
|
721
|
+
</div><aside class="tsd-sources">
|
|
722
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslint</p></aside></section>
|
|
723
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslintOptions" class="tsd-anchor"></a>
|
|
724
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint<wbr/>Options</span><a href="#eslintOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
725
|
+
<div class="tsd-signature"><span class="tsd-kind-property">eslint<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">EslintOptions</span></div>
|
|
726
|
+
<div class="tsd-comment tsd-typography"><p>Eslint options</p>
|
|
727
|
+
|
|
728
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">opinionated</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
729
|
+
</code></pre>
|
|
730
|
+
</div><aside class="tsd-sources">
|
|
731
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslintOptions</p></aside></section>
|
|
732
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="featureFlags" class="tsd-anchor"></a>
|
|
733
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>feature<wbr/>Flags</span><a href="#featureFlags" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
734
|
+
<div class="tsd-signature"><span class="tsd-kind-property">feature<wbr/>Flags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
735
|
+
<div class="tsd-comment tsd-typography"><p>Include all feature flags in cdk.json</p>
|
|
736
|
+
|
|
737
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
738
|
+
</code></pre>
|
|
739
|
+
</div><aside class="tsd-sources">
|
|
740
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.featureFlags</p></aside></section>
|
|
741
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitIgnoreOptions" class="tsd-anchor"></a>
|
|
742
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>git<wbr/>Ignore<wbr/>Options</span><a href="#gitIgnoreOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
743
|
+
<div class="tsd-signature"><span class="tsd-kind-property">git<wbr/>Ignore<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IgnoreFileOptions</span></div>
|
|
744
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for .gitignore file</p>
|
|
745
|
+
</div><aside class="tsd-sources">
|
|
746
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitIgnoreOptions</p></aside></section>
|
|
747
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitOptions" class="tsd-anchor"></a>
|
|
748
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>git<wbr/>Options</span><a href="#gitOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
749
|
+
<div class="tsd-signature"><span class="tsd-kind-property">git<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GitOptions</span></div>
|
|
750
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for git</p>
|
|
751
|
+
</div><aside class="tsd-sources">
|
|
752
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitOptions</p></aside></section>
|
|
753
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="github" class="tsd-anchor"></a>
|
|
754
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github</span><a href="#github" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
755
|
+
<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>
|
|
756
|
+
<div class="tsd-comment tsd-typography"><p>Enable GitHub integration.</p>
|
|
757
|
+
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
758
|
+
|
|
759
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
760
|
+
</code></pre>
|
|
761
|
+
</div><aside class="tsd-sources">
|
|
762
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.github</p></aside></section>
|
|
763
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="githubOptions" class="tsd-anchor"></a>
|
|
764
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github<wbr/>Options</span><a href="#githubOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
765
|
+
<div class="tsd-signature"><span class="tsd-kind-property">github<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GitHubOptions</span></div>
|
|
766
|
+
<div class="tsd-comment tsd-typography"><p>Options for GitHub integration</p>
|
|
767
|
+
|
|
768
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">see</span><span class="hl-0"> </span><span class="hl-3">GitHubOptions</span>
|
|
769
|
+
</code></pre>
|
|
770
|
+
</div><aside class="tsd-sources">
|
|
771
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.githubOptions</p></aside></section>
|
|
772
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a>
|
|
773
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitignore</span><a href="#gitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
774
|
+
<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>
|
|
775
|
+
<div class="tsd-comment tsd-typography"><p>Additional entries to .gitignore</p>
|
|
776
|
+
</div><aside class="tsd-sources">
|
|
777
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitignore</p></aside></section>
|
|
778
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitpod" class="tsd-anchor"></a>
|
|
779
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitpod</span><a href="#gitpod" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
780
|
+
<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>
|
|
781
|
+
<div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment</p>
|
|
782
|
+
|
|
783
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
784
|
+
</code></pre>
|
|
785
|
+
</div><aside class="tsd-sources">
|
|
786
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitpod</p></aside></section>
|
|
787
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="homepage" class="tsd-anchor"></a>
|
|
788
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>homepage</span><a href="#homepage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
789
|
+
<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>
|
|
790
|
+
<div class="tsd-comment tsd-typography"><p>Package's Homepage / Website</p>
|
|
791
|
+
</div><aside class="tsd-sources">
|
|
792
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.homepage</p></aside></section>
|
|
793
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="integrationTestAutoDiscover" class="tsd-anchor"></a>
|
|
794
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span><a href="#integrationTestAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
795
|
+
<div class="tsd-signature"><span class="tsd-kind-property">integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
796
|
+
<div class="tsd-comment tsd-typography"><p>Automatically discovers and creates integration tests for each <code>.integ.ts</code>
|
|
797
|
+
file in under your test directory.</p>
|
|
798
|
+
|
|
799
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
800
|
+
</code></pre>
|
|
801
|
+
</div><aside class="tsd-sources">
|
|
802
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.integrationTestAutoDiscover</p></aside></section>
|
|
803
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jest" class="tsd-anchor"></a>
|
|
804
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jest</span><a href="#jest" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
805
|
+
<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>
|
|
806
|
+
<div class="tsd-comment tsd-typography"><p>Setup jest unit tests</p>
|
|
807
|
+
|
|
808
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
809
|
+
</code></pre>
|
|
810
|
+
</div><aside class="tsd-sources">
|
|
811
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jest</p></aside></section>
|
|
812
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jestOptions" class="tsd-anchor"></a>
|
|
813
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jest<wbr/>Options</span><a href="#jestOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
814
|
+
<div class="tsd-signature"><span class="tsd-kind-property">jest<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JestOptions</span></div>
|
|
815
|
+
<div class="tsd-comment tsd-typography"><p>Jest options</p>
|
|
816
|
+
|
|
817
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
818
|
+
</code></pre>
|
|
819
|
+
</div><aside class="tsd-sources">
|
|
820
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jestOptions</p></aside></section>
|
|
821
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jsiiReleaseVersion" class="tsd-anchor"></a>
|
|
822
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jsii<wbr/>Release<wbr/>Version</span><a href="#jsiiReleaseVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
823
|
+
<div class="tsd-signature"><span class="tsd-kind-property">jsii<wbr/>Release<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
824
|
+
<div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
825
|
+
|
|
826
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"latest"</span>
|
|
827
|
+
</code></pre>
|
|
828
|
+
</div><aside class="tsd-sources">
|
|
829
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jsiiReleaseVersion</p></aside></section>
|
|
830
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keywords" class="tsd-anchor"></a>
|
|
831
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>keywords</span><a href="#keywords" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
832
|
+
<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>
|
|
833
|
+
<div class="tsd-comment tsd-typography"><p>Keywords to include in <code>package.json</code>.</p>
|
|
834
|
+
</div><aside class="tsd-sources">
|
|
835
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.keywords</p></aside></section>
|
|
836
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaAutoDiscover" class="tsd-anchor"></a>
|
|
837
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Auto<wbr/>Discover</span><a href="#lambdaAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
838
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
839
|
+
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaFunction</code> for each <code>.lambda.ts</code> handler
|
|
840
|
+
in your source tree. If this is disabled, you can manually add an
|
|
841
|
+
<code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
842
|
+
|
|
843
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
844
|
+
</code></pre>
|
|
845
|
+
</div><aside class="tsd-sources">
|
|
846
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaAutoDiscover</p></aside></section>
|
|
847
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaExtensionAutoDiscover" class="tsd-anchor"></a>
|
|
848
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span><a href="#lambdaExtensionAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
849
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
850
|
+
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaExtension</code> for each <code>.lambda-extension.ts</code>
|
|
851
|
+
entrypoint in your source tree. If this is disabled, you can manually add an
|
|
852
|
+
<code>awscdk.AutoDiscover</code> component to your project</p>
|
|
853
|
+
|
|
854
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
855
|
+
</code></pre>
|
|
856
|
+
</div><aside class="tsd-sources">
|
|
857
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaExtensionAutoDiscover</p></aside></section>
|
|
858
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
859
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
860
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">LambdaFunctionCommonOptions</span></div>
|
|
861
|
+
<div class="tsd-comment tsd-typography"><p>Common options for all AWS Lambda functions.</p>
|
|
862
|
+
|
|
863
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
864
|
+
</code></pre>
|
|
865
|
+
</div><aside class="tsd-sources">
|
|
866
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaOptions</p></aside></section>
|
|
867
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="libdir" class="tsd-anchor"></a>
|
|
868
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
869
|
+
<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>
|
|
870
|
+
<div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory</p>
|
|
871
|
+
|
|
872
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"lib"</span>
|
|
873
|
+
</code></pre>
|
|
874
|
+
</div><aside class="tsd-sources">
|
|
875
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.libdir</p></aside></section>
|
|
876
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="license" class="tsd-anchor"></a>
|
|
877
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>license</span><a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
878
|
+
<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>
|
|
879
|
+
<div class="tsd-comment tsd-typography"><p>License's SPDX identifier.
|
|
880
|
+
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.
|
|
881
|
+
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
882
|
+
|
|
883
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"Apache-2.0"</span>
|
|
884
|
+
</code></pre>
|
|
885
|
+
</div><aside class="tsd-sources">
|
|
886
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.license</p></aside></section>
|
|
887
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="licensed" class="tsd-anchor"></a>
|
|
888
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>licensed</span><a href="#licensed" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
889
|
+
<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>
|
|
890
|
+
<div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
891
|
+
|
|
892
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
893
|
+
</code></pre>
|
|
894
|
+
</div><aside class="tsd-sources">
|
|
895
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.licensed</p></aside></section>
|
|
896
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logging" class="tsd-anchor"></a>
|
|
897
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logging</span><a href="#logging" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
898
|
+
<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>
|
|
899
|
+
<div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
900
|
+
|
|
901
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">{}</span>
|
|
902
|
+
</code></pre>
|
|
903
|
+
</div><aside class="tsd-sources">
|
|
904
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.logging</p></aside></section>
|
|
905
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="majorVersion" class="tsd-anchor"></a>
|
|
906
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>major<wbr/>Version</span><a href="#majorVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
907
|
+
<div class="tsd-signature"><span class="tsd-kind-property">major<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
908
|
+
<div class="tsd-comment tsd-typography"><p>Major version to release from the default branch.</p>
|
|
909
|
+
<p>If this is specified, we bump the latest version of this major version line.
|
|
910
|
+
If not specified, we bump the global latest version.</p>
|
|
911
|
+
|
|
912
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">Major</span><span class="hl-0"> </span><span class="hl-3">version</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">enforced</span><span class="hl-0">.</span>
|
|
913
|
+
</code></pre>
|
|
914
|
+
</div><aside class="tsd-sources">
|
|
915
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.majorVersion</p></aside></section>
|
|
916
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" class="tsd-anchor"></a>
|
|
917
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max<wbr/>Node<wbr/>Version</span><a href="#maxNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
918
|
+
<div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
919
|
+
<div class="tsd-comment tsd-typography"><p>Minimum node.js version to require via <code>engines</code> (inclusive).</p>
|
|
920
|
+
|
|
921
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">max</span>
|
|
922
|
+
</code></pre>
|
|
923
|
+
</div><aside class="tsd-sources">
|
|
924
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.maxNodeVersion</p></aside></section>
|
|
925
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergify" class="tsd-anchor"></a>
|
|
926
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">mergify</span><a href="#mergify" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
927
|
+
<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>
|
|
928
|
+
<div class="tsd-comment tsd-typography"><p>Whether mergify should be enabled on this repository or not.</p>
|
|
929
|
+
|
|
930
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
931
|
+
</code></pre>
|
|
932
|
+
|
|
933
|
+
<h3>Deprecated</h3><p>use <code>githubOptions.mergify</code> instead</p>
|
|
934
|
+
</div><aside class="tsd-sources">
|
|
935
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergify</p></aside></section>
|
|
936
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergifyOptions" class="tsd-anchor"></a>
|
|
937
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">mergify<wbr/>Options</span><a href="#mergifyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
938
|
+
<div class="tsd-signature"><span class="tsd-kind-property">mergify<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">MergifyOptions</span></div>
|
|
939
|
+
<div class="tsd-comment tsd-typography"><p>Options for mergify</p>
|
|
940
|
+
|
|
941
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
942
|
+
</code></pre>
|
|
943
|
+
|
|
944
|
+
<h3>Deprecated</h3><p>use <code>githubOptions.mergifyOptions</code> instead</p>
|
|
945
|
+
</div><aside class="tsd-sources">
|
|
946
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergifyOptions</p></aside></section>
|
|
947
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minMajorVersion" class="tsd-anchor"></a>
|
|
948
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>min<wbr/>Major<wbr/>Version</span><a href="#minMajorVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
949
|
+
<div class="tsd-signature"><span class="tsd-kind-property">min<wbr/>Major<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
950
|
+
<div class="tsd-comment tsd-typography"><p>Minimal Major version to release</p>
|
|
951
|
+
<p>This can be useful to set to 1, as breaking changes before the 1.x major
|
|
952
|
+
release are not incrementing the major version number.</p>
|
|
953
|
+
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
954
|
+
|
|
955
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">No</span><span class="hl-0"> </span><span class="hl-3">minimum</span><span class="hl-0"> </span><span class="hl-3">version</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">being</span><span class="hl-0"> </span><span class="hl-3">enforced</span>
|
|
956
|
+
</code></pre>
|
|
957
|
+
</div><aside class="tsd-sources">
|
|
958
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minMajorVersion</p></aside></section>
|
|
959
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" class="tsd-anchor"></a>
|
|
960
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>min<wbr/>Node<wbr/>Version</span><a href="#minNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
961
|
+
<div class="tsd-signature"><span class="tsd-kind-property">min<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
962
|
+
<div class="tsd-comment tsd-typography"><p>Minimum Node.js version to require via package.json <code>engines</code> (inclusive).</p>
|
|
963
|
+
|
|
964
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-1">"engines"</span><span class="hl-0"> </span><span class="hl-3">specified</span>
|
|
965
|
+
</code></pre>
|
|
966
|
+
</div><aside class="tsd-sources">
|
|
967
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minNodeVersion</p></aside></section>
|
|
968
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mutableBuild" class="tsd-anchor"></a>
|
|
969
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>mutable<wbr/>Build</span><a href="#mutableBuild" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
970
|
+
<div class="tsd-signature"><span class="tsd-kind-property">mutable<wbr/>Build</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
971
|
+
<div class="tsd-comment tsd-typography"><p>Automatically update files modified during builds to pull-request branches. This means
|
|
972
|
+
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
973
|
+
before a PR is merged.</p>
|
|
974
|
+
<p>Implies that PR builds do not have anti-tamper checks.</p>
|
|
975
|
+
|
|
976
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
977
|
+
</code></pre>
|
|
978
|
+
</div><aside class="tsd-sources">
|
|
979
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mutableBuild</p></aside></section>
|
|
980
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
|
|
981
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
982
|
+
<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>
|
|
983
|
+
<div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
984
|
+
|
|
985
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">$BASEDIR</span>
|
|
986
|
+
</code></pre>
|
|
987
|
+
|
|
988
|
+
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
989
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.name</p></aside></section>
|
|
990
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmAccess" class="tsd-anchor"></a>
|
|
991
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Access</span><a href="#npmAccess" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
992
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Access</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">NpmAccess</span></div>
|
|
993
|
+
<div class="tsd-comment tsd-typography"><p>Access level of the npm package.</p>
|
|
994
|
+
|
|
995
|
+
<h3>Default</h3><ul>
|
|
996
|
+
<li>for scoped packages (e.g. <code>foo@bar</code>), the default is
|
|
997
|
+
<code>NpmAccess.RESTRICTED</code>, for non-scoped packages, the default is
|
|
998
|
+
<code>NpmAccess.PUBLIC</code>.</li>
|
|
999
|
+
</ul>
|
|
1000
|
+
</div><aside class="tsd-sources">
|
|
1001
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmAccess</p></aside></section>
|
|
1002
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmDistTag" class="tsd-anchor"></a>
|
|
1003
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Dist<wbr/>Tag</span><a href="#npmDistTag" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1004
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Dist<wbr/>Tag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1005
|
+
<div class="tsd-comment tsd-typography"><p>The npmDistTag to use when publishing from the default branch.</p>
|
|
1006
|
+
<p>To set the npm dist-tag for release branches, set the <code>npmDistTag</code> property
|
|
1007
|
+
for each branch.</p>
|
|
1008
|
+
|
|
1009
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"latest"</span>
|
|
1010
|
+
</code></pre>
|
|
1011
|
+
</div><aside class="tsd-sources">
|
|
1012
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmDistTag</p></aside></section>
|
|
1013
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmIgnoreOptions" class="tsd-anchor"></a>
|
|
1014
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Ignore<wbr/>Options</span><a href="#npmIgnoreOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1015
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Ignore<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IgnoreFileOptions</span></div>
|
|
1016
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for .npmignore file</p>
|
|
1017
|
+
</div><aside class="tsd-sources">
|
|
1018
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmIgnoreOptions</p></aside></section>
|
|
1019
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmRegistry" class="tsd-anchor"></a>
|
|
1020
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">npm<wbr/>Registry</span><a href="#npmRegistry" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1021
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Registry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1022
|
+
<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>
|
|
1023
|
+
|
|
1024
|
+
<h3>Deprecated</h3><p>use <code>npmRegistryUrl</code> instead</p>
|
|
1025
|
+
</div><aside class="tsd-sources">
|
|
1026
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistry</p></aside></section>
|
|
1027
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmRegistryUrl" class="tsd-anchor"></a>
|
|
1028
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Registry<wbr/>Url</span><a href="#npmRegistryUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1029
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Registry<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1030
|
+
<div class="tsd-comment tsd-typography"><p>The base URL of the npm package registry.</p>
|
|
1031
|
+
<p>Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
1032
|
+
|
|
1033
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"https://registry.npmjs.org"</span>
|
|
1034
|
+
</code></pre>
|
|
1035
|
+
</div><aside class="tsd-sources">
|
|
1036
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistryUrl</p></aside></section>
|
|
1037
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmTokenSecret" class="tsd-anchor"></a>
|
|
1038
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Token<wbr/>Secret</span><a href="#npmTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1039
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Token<wbr/>Secret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1040
|
+
<div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
1041
|
+
|
|
1042
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"NPM_TOKEN"</span>
|
|
1043
|
+
</code></pre>
|
|
1044
|
+
</div><aside class="tsd-sources">
|
|
1045
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmTokenSecret</p></aside></section>
|
|
1046
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a>
|
|
1047
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">npmignore</span><a href="#npmignore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1048
|
+
<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>
|
|
1049
|
+
<div class="tsd-comment tsd-typography"><p>Additional entries to .npmignore.</p>
|
|
1050
|
+
|
|
1051
|
+
<h3>Deprecated</h3><ul>
|
|
1052
|
+
<li>use <code>project.addPackageIgnore</code></li>
|
|
1053
|
+
</ul>
|
|
1054
|
+
</div><aside class="tsd-sources">
|
|
1055
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignore</p></aside></section>
|
|
1056
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignoreEnabled" class="tsd-anchor"></a>
|
|
1057
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npmignore<wbr/>Enabled</span><a href="#npmignoreEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1058
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npmignore<wbr/>Enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1059
|
+
<div class="tsd-comment tsd-typography"><p>Defines an .npmignore file. Normally this is only needed for libraries that
|
|
1060
|
+
are packaged as tarballs.</p>
|
|
1061
|
+
|
|
1062
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1063
|
+
</code></pre>
|
|
1064
|
+
</div><aside class="tsd-sources">
|
|
1065
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignoreEnabled</p></aside></section>
|
|
1066
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
1067
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>outdir</span><a href="#outdir" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1068
|
+
<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>
|
|
1069
|
+
<div class="tsd-comment tsd-typography"><p>The root directory of the project.</p>
|
|
1070
|
+
<p>Relative to this directory, all files are synthesized.</p>
|
|
1071
|
+
<p>If this project has a parent, this directory is relative to the parent
|
|
1072
|
+
directory and it cannot be the same as the parent or any of it's other
|
|
1073
|
+
sub-projects.</p>
|
|
1074
|
+
|
|
1075
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"."</span>
|
|
1076
|
+
</code></pre>
|
|
1077
|
+
</div><aside class="tsd-sources">
|
|
1078
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.outdir</p></aside></section>
|
|
1079
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a>
|
|
1080
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1081
|
+
<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>
|
|
1082
|
+
<div class="tsd-comment tsd-typography"><p>Defines a <code>package</code> task that will produce an npm tarball under the
|
|
1083
|
+
artifacts directory (e.g. <code>dist</code>).</p>
|
|
1084
|
+
|
|
1085
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1086
|
+
</code></pre>
|
|
1087
|
+
</div><aside class="tsd-sources">
|
|
1088
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.package</p></aside></section>
|
|
1089
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
1090
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package<wbr/>Manager</span><a href="#packageManager" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1091
|
+
<div class="tsd-signature"><span class="tsd-kind-property">package<wbr/>Manager</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">NodePackageManager</span></div>
|
|
1092
|
+
<div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts</p>
|
|
1093
|
+
|
|
1094
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">NodePackageManager</span><span class="hl-0">.</span><span class="hl-5">YARN</span>
|
|
1095
|
+
</code></pre>
|
|
1096
|
+
</div><aside class="tsd-sources">
|
|
1097
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageManager</p></aside></section>
|
|
1098
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageName" class="tsd-anchor"></a>
|
|
1099
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package<wbr/>Name</span><a href="#packageName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1100
|
+
<div class="tsd-signature"><span class="tsd-kind-property">package<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1101
|
+
<div class="tsd-comment tsd-typography"><p>The "name" in package.json</p>
|
|
1102
|
+
|
|
1103
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">defaults</span><span class="hl-0"> </span><span class="hl-3">to</span><span class="hl-0"> </span><span class="hl-3">project</span><span class="hl-0"> </span><span class="hl-3">name</span>
|
|
1104
|
+
</code></pre>
|
|
1105
|
+
|
|
1106
|
+
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
1107
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageName</p></aside></section>
|
|
1108
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="parent" class="tsd-anchor"></a>
|
|
1109
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1110
|
+
<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>
|
|
1111
|
+
<div class="tsd-comment tsd-typography"><p>The parent project, if this project is part of a bigger project.</p>
|
|
1112
|
+
</div><aside class="tsd-sources">
|
|
1113
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.parent</p></aside></section>
|
|
1114
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="peerDependencyOptions" class="tsd-anchor"></a>
|
|
1115
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>peer<wbr/>Dependency<wbr/>Options</span><a href="#peerDependencyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1116
|
+
<div class="tsd-signature"><span class="tsd-kind-property">peer<wbr/>Dependency<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">PeerDependencyOptions</span></div>
|
|
1117
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>peerDeps</code>.</p>
|
|
1118
|
+
</div><aside class="tsd-sources">
|
|
1119
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDependencyOptions</p></aside></section>
|
|
1120
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="peerDeps" class="tsd-anchor"></a>
|
|
1121
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>peer<wbr/>Deps</span><a href="#peerDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1122
|
+
<div class="tsd-signature"><span class="tsd-kind-property">peer<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1123
|
+
<div class="tsd-comment tsd-typography"><p>Peer dependencies for this module. Dependencies listed here are required to
|
|
1124
|
+
be installed (and satisfied) by the <em>consumer</em> of this library. Using peer
|
|
1125
|
+
dependencies allows you to ensure that only a single module of a certain
|
|
1126
|
+
library exists in the <code>node_modules</code> tree of your consumers.</p>
|
|
1127
|
+
<p>Note that prior to npm@7, peer dependencies are <em>not</em> automatically
|
|
1128
|
+
installed, which means that adding peer dependencies to a library will be a
|
|
1129
|
+
breaking change for your customers.</p>
|
|
1130
|
+
<p>Unless <code>peerDependencyOptions.pinnedDevDependency</code> is disabled (it is
|
|
1131
|
+
enabled by default), projen will automatically add a dev dependency with a
|
|
1132
|
+
pinned version for each peer dependency. This will ensure that you build &
|
|
1133
|
+
test your module against the lowest peer version required.</p>
|
|
1134
|
+
|
|
1135
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1136
|
+
</code></pre>
|
|
1137
|
+
</div><aside class="tsd-sources">
|
|
1138
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDeps</p></aside></section>
|
|
1139
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pnpmVersion" class="tsd-anchor"></a>
|
|
1140
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pnpm<wbr/>Version</span><a href="#pnpmVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1141
|
+
<div class="tsd-signature"><span class="tsd-kind-property">pnpm<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1142
|
+
<div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
1143
|
+
|
|
1144
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"7"</span>
|
|
1145
|
+
</code></pre>
|
|
1146
|
+
</div><aside class="tsd-sources">
|
|
1147
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pnpmVersion</p></aside></section>
|
|
1148
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postBuildSteps" class="tsd-anchor"></a>
|
|
1149
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>post<wbr/>Build<wbr/>Steps</span><a href="#postBuildSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1150
|
+
<div class="tsd-signature"><span class="tsd-kind-property">post<wbr/>Build<wbr/>Steps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1151
|
+
<div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
1152
|
+
|
|
1153
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1154
|
+
</code></pre>
|
|
1155
|
+
</div><aside class="tsd-sources">
|
|
1156
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.postBuildSteps</p></aside></section>
|
|
1157
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prerelease" class="tsd-anchor"></a>
|
|
1158
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prerelease</span><a href="#prerelease" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1159
|
+
<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>
|
|
1160
|
+
<div class="tsd-comment tsd-typography"><p>Bump versions from the default branch as pre-releases (e.g. "beta",
|
|
1161
|
+
"alpha", "pre").</p>
|
|
1162
|
+
|
|
1163
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">normal</span><span class="hl-0"> </span><span class="hl-3">semantic</span><span class="hl-0"> </span><span class="hl-3">versions</span>
|
|
1164
|
+
</code></pre>
|
|
1165
|
+
</div><aside class="tsd-sources">
|
|
1166
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prerelease</p></aside></section>
|
|
1167
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" class="tsd-anchor"></a>
|
|
1168
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier</span><a href="#prettier" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1169
|
+
<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>
|
|
1170
|
+
<div class="tsd-comment tsd-typography"><p>Setup prettier.</p>
|
|
1171
|
+
|
|
1172
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1173
|
+
</code></pre>
|
|
1174
|
+
</div><aside class="tsd-sources">
|
|
1175
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettier</p></aside></section>
|
|
1176
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettierOptions" class="tsd-anchor"></a>
|
|
1177
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier<wbr/>Options</span><a href="#prettierOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1178
|
+
<div class="tsd-signature"><span class="tsd-kind-property">prettier<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">PrettierOptions</span></div>
|
|
1179
|
+
<div class="tsd-comment tsd-typography"><p>Prettier options</p>
|
|
1180
|
+
|
|
1181
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1182
|
+
</code></pre>
|
|
1183
|
+
</div><aside class="tsd-sources">
|
|
1184
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettierOptions</p></aside></section>
|
|
1185
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectType" class="tsd-anchor"></a>
|
|
1186
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">project<wbr/>Type</span><a href="#projectType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1187
|
+
<div class="tsd-signature"><span class="tsd-kind-property">project<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjectType</span></div>
|
|
1188
|
+
<div class="tsd-comment tsd-typography"><p>Which type of project this is (library/app).</p>
|
|
1189
|
+
|
|
1190
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">ProjectType</span><span class="hl-0">.</span><span class="hl-5">UNKNOWN</span>
|
|
1191
|
+
</code></pre>
|
|
1192
|
+
|
|
1193
|
+
<h3>Deprecated</h3><p>no longer supported at the base project level</p>
|
|
1194
|
+
</div><aside class="tsd-sources">
|
|
1195
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projectType</p></aside></section>
|
|
1196
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCommand" class="tsd-anchor"></a>
|
|
1197
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Command</span><a href="#projenCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1198
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Command</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1199
|
+
<div class="tsd-comment tsd-typography"><p>The shell command to use in order to run the projen CLI.</p>
|
|
1200
|
+
<p>Can be used to customize in special environments.</p>
|
|
1201
|
+
|
|
1202
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"npx projen"</span>
|
|
1203
|
+
</code></pre>
|
|
1204
|
+
</div><aside class="tsd-sources">
|
|
1205
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCommand</p></aside></section>
|
|
1206
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCredentials" class="tsd-anchor"></a>
|
|
1207
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Credentials</span><a href="#projenCredentials" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1208
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Credentials</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GithubCredentials</span></div>
|
|
1209
|
+
<div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
1210
|
+
|
|
1211
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">use</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> </span><span class="hl-3">personal</span><span class="hl-0"> </span><span class="hl-3">access</span><span class="hl-0"> </span><span class="hl-3">token</span><span class="hl-0"> </span><span class="hl-3">named</span><span class="hl-0"> </span><span class="hl-5">PROJEN_GITHUB_TOKEN</span>
|
|
1212
|
+
</code></pre>
|
|
1213
|
+
</div><aside class="tsd-sources">
|
|
1214
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCredentials</p></aside></section>
|
|
1215
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenDevDependency" class="tsd-anchor"></a>
|
|
1216
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Dev<wbr/>Dependency</span><a href="#projenDevDependency" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1217
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Dev<wbr/>Dependency</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1218
|
+
<div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
1219
|
+
|
|
1220
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1221
|
+
</code></pre>
|
|
1222
|
+
</div><aside class="tsd-sources">
|
|
1223
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenDevDependency</p></aside></section>
|
|
1224
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenTokenSecret" class="tsd-anchor"></a>
|
|
1225
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">projen<wbr/>Token<wbr/>Secret</span><a href="#projenTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1226
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Token<wbr/>Secret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1227
|
+
<div class="tsd-comment tsd-typography"><p>The name of a secret which includes a GitHub Personal Access Token to be
|
|
1228
|
+
used by projen workflows. This token needs to have the <code>repo</code>, <code>workflows</code>
|
|
1229
|
+
and <code>packages</code> scope.</p>
|
|
1230
|
+
|
|
1231
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"PROJEN_GITHUB_TOKEN"</span>
|
|
1232
|
+
</code></pre>
|
|
1233
|
+
|
|
1234
|
+
<h3>Deprecated</h3><p>use <code>projenCredentials</code></p>
|
|
1235
|
+
</div><aside class="tsd-sources">
|
|
1236
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenTokenSecret</p></aside></section>
|
|
1237
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenVersion" class="tsd-anchor"></a>
|
|
1238
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Version</span><a href="#projenVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1239
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1240
|
+
<div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
1241
|
+
|
|
1242
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">Defaults</span><span class="hl-0"> </span><span class="hl-3">to</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">latest</span><span class="hl-0"> </span><span class="hl-3">version</span><span class="hl-0">.</span>
|
|
1243
|
+
</code></pre>
|
|
1244
|
+
</div><aside class="tsd-sources">
|
|
1245
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenVersion</p></aside></section>
|
|
1246
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJs" class="tsd-anchor"></a>
|
|
1247
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Js</span><a href="#projenrcJs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1248
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Js</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1249
|
+
<div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.js (in JavaScript). Set to <code>false</code> in order to disable
|
|
1250
|
+
.projenrc.js generation.</p>
|
|
1251
|
+
|
|
1252
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-3">projenrcJson</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-2">false</span>
|
|
1253
|
+
</code></pre>
|
|
1254
|
+
</div><aside class="tsd-sources">
|
|
1255
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJs</p></aside></section>
|
|
1256
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsOptions" class="tsd-anchor"></a>
|
|
1257
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Js<wbr/>Options</span><a href="#projenrcJsOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1258
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Js<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjenrcOptions</span></div>
|
|
1259
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.js</p>
|
|
1260
|
+
|
|
1261
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1262
|
+
</code></pre>
|
|
1263
|
+
</div><aside class="tsd-sources">
|
|
1264
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsOptions</p></aside></section>
|
|
1265
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJson" class="tsd-anchor"></a>
|
|
1266
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Json</span><a href="#projenrcJson" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1267
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Json</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1268
|
+
<div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.json (in JSON). Set to <code>false</code> in order to disable
|
|
1269
|
+
.projenrc.json generation.</p>
|
|
1270
|
+
|
|
1271
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1272
|
+
</code></pre>
|
|
1273
|
+
</div><aside class="tsd-sources">
|
|
1274
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJson</p></aside></section>
|
|
1275
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsonOptions" class="tsd-anchor"></a>
|
|
1276
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Json<wbr/>Options</span><a href="#projenrcJsonOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1277
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Json<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjenrcJsonOptions</span></div>
|
|
1278
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.json</p>
|
|
1279
|
+
|
|
1280
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1281
|
+
</code></pre>
|
|
1282
|
+
</div><aside class="tsd-sources">
|
|
1283
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsonOptions</p></aside></section>
|
|
1284
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTs" class="tsd-anchor"></a>
|
|
1285
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Ts</span><a href="#projenrcTs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1286
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Ts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1287
|
+
<div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
1288
|
+
|
|
1289
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1290
|
+
</code></pre>
|
|
1291
|
+
|
|
1292
|
+
<h3>Pjnew</h3><p>true</p>
|
|
1293
|
+
</div><aside class="tsd-sources">
|
|
1294
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTs</p></aside></section>
|
|
1295
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTsOptions" class="tsd-anchor"></a>
|
|
1296
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrcTsOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1297
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Ts<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjenrcOptions</span></div>
|
|
1298
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.ts</p>
|
|
1299
|
+
</div><aside class="tsd-sources">
|
|
1300
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTsOptions</p></aside></section>
|
|
1301
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishDryRun" class="tsd-anchor"></a>
|
|
1302
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>publish<wbr/>Dry<wbr/>Run</span><a href="#publishDryRun" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1303
|
+
<div class="tsd-signature"><span class="tsd-kind-property">publish<wbr/>Dry<wbr/>Run</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1304
|
+
<div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
1305
|
+
|
|
1306
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1307
|
+
</code></pre>
|
|
1308
|
+
</div><aside class="tsd-sources">
|
|
1309
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishDryRun</p></aside></section>
|
|
1310
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishTasks" class="tsd-anchor"></a>
|
|
1311
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>publish<wbr/>Tasks</span><a href="#publishTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1312
|
+
<div class="tsd-signature"><span class="tsd-kind-property">publish<wbr/>Tasks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1313
|
+
<div class="tsd-comment tsd-typography"><p>Define publishing tasks that can be executed manually as well as workflows.</p>
|
|
1314
|
+
<p>Normally, publishing only happens within automated workflows. Enable this
|
|
1315
|
+
in order to create a publishing task for each publishing activity.</p>
|
|
1316
|
+
|
|
1317
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1318
|
+
</code></pre>
|
|
1319
|
+
</div><aside class="tsd-sources">
|
|
1320
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishTasks</p></aside></section>
|
|
1321
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplate" class="tsd-anchor"></a>
|
|
1322
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pull<wbr/>Request<wbr/>Template</span><a href="#pullRequestTemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1323
|
+
<div class="tsd-signature"><span class="tsd-kind-property">pull<wbr/>Request<wbr/>Template</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1324
|
+
<div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
1325
|
+
|
|
1326
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1327
|
+
</code></pre>
|
|
1328
|
+
</div><aside class="tsd-sources">
|
|
1329
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplate</p></aside></section>
|
|
1330
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplateContents" class="tsd-anchor"></a>
|
|
1331
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><a href="#pullRequestTemplateContents" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1332
|
+
<div class="tsd-signature"><span class="tsd-kind-property">pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1333
|
+
<div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
|
|
1334
|
+
|
|
1335
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">content</span>
|
|
1336
|
+
</code></pre>
|
|
1337
|
+
</div><aside class="tsd-sources">
|
|
1338
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplateContents</p></aside></section>
|
|
1339
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readme" class="tsd-anchor"></a>
|
|
1340
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readme</span><a href="#readme" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1341
|
+
<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>
|
|
1342
|
+
<div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
1343
|
+
|
|
1344
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- { </span><span class="hl-8">filename</span><span class="hl-0">: </span><span class="hl-1">'README.md'</span><span class="hl-0">, </span><span class="hl-8">contents</span><span class="hl-0">: </span><span class="hl-1">'# replace this'</span><span class="hl-0"> }</span>
|
|
1345
|
+
</code></pre>
|
|
1346
|
+
|
|
1347
|
+
<h3>Example</h3><pre><code class="language-ts"><span class="hl-1">"{ filename: 'readme.md', contents: '# title' }"</span>
|
|
1348
|
+
</code></pre>
|
|
1349
|
+
</div><aside class="tsd-sources">
|
|
1350
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.readme</p></aside></section>
|
|
1351
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a>
|
|
1352
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1353
|
+
<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>
|
|
1354
|
+
<div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
1355
|
+
|
|
1356
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> (</span><span class="hl-2">false</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-3">subprojects</span><span class="hl-0">)</span>
|
|
1357
|
+
</code></pre>
|
|
1358
|
+
</div><aside class="tsd-sources">
|
|
1359
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.release</p></aside></section>
|
|
1360
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseBranches" class="tsd-anchor"></a>
|
|
1361
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Branches</span><a href="#releaseBranches" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1362
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Branches</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</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><br/><span class="tsd-signature-symbol">}</span></div>
|
|
1363
|
+
<div class="tsd-comment tsd-typography"><p>Defines additional release branches. A workflow will be created for each
|
|
1364
|
+
release branch which will publish releases from commits in this branch.
|
|
1365
|
+
Each release branch <em>must</em> be assigned a major version number which is used
|
|
1366
|
+
to enforce that versions published from that branch always use that major
|
|
1367
|
+
version. If multiple branches are used, the <code>majorVersion</code> field must also
|
|
1368
|
+
be provided for the default branch.</p>
|
|
1369
|
+
|
|
1370
|
+
<h3>Default</h3><ul>
|
|
1371
|
+
<li>no additional branches are used for release. you can use
|
|
1372
|
+
<code>addBranch()</code> to add additional branches.</li>
|
|
1373
|
+
</ul>
|
|
1374
|
+
</div>
|
|
1375
|
+
<div class="tsd-type-declaration">
|
|
1376
|
+
<h4>Type declaration</h4>
|
|
1377
|
+
<ul class="tsd-parameters">
|
|
1378
|
+
<li class="tsd-parameter-index-signature">
|
|
1379
|
+
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type ">BranchOptions</span></h5></li></ul></div><aside class="tsd-sources">
|
|
1380
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseBranches</p></aside></section>
|
|
1381
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseEveryCommit" class="tsd-anchor"></a>
|
|
1382
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Every<wbr/>Commit</span><a href="#releaseEveryCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1383
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Every<wbr/>Commit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1384
|
+
<div class="tsd-comment tsd-typography"><p>Automatically release new versions every commit to one of branches in <code>releaseBranches</code>.</p>
|
|
1385
|
+
|
|
1386
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1387
|
+
</code></pre>
|
|
1388
|
+
|
|
1389
|
+
<h3>Deprecated</h3><p>Use <code>releaseTrigger: ReleaseTrigger.continuous()</code> instead</p>
|
|
1390
|
+
</div><aside class="tsd-sources">
|
|
1391
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseEveryCommit</p></aside></section>
|
|
1392
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssue" class="tsd-anchor"></a>
|
|
1393
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Failure<wbr/>Issue</span><a href="#releaseFailureIssue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1394
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Failure<wbr/>Issue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1395
|
+
<div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
1396
|
+
|
|
1397
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1398
|
+
</code></pre>
|
|
1399
|
+
</div><aside class="tsd-sources">
|
|
1400
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssue</p></aside></section>
|
|
1401
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssueLabel" class="tsd-anchor"></a>
|
|
1402
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><a href="#releaseFailureIssueLabel" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1403
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1404
|
+
<div class="tsd-comment tsd-typography"><p>The label to apply to issues indicating publish failures.
|
|
1405
|
+
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
1406
|
+
|
|
1407
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"failed-release"</span>
|
|
1408
|
+
</code></pre>
|
|
1409
|
+
</div><aside class="tsd-sources">
|
|
1410
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssueLabel</p></aside></section>
|
|
1411
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseSchedule" class="tsd-anchor"></a>
|
|
1412
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Schedule</span><a href="#releaseSchedule" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1413
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Schedule</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1414
|
+
<div class="tsd-comment tsd-typography"><p>CRON schedule to trigger new releases.</p>
|
|
1415
|
+
|
|
1416
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">scheduled</span><span class="hl-0"> </span><span class="hl-3">releases</span>
|
|
1417
|
+
</code></pre>
|
|
1418
|
+
|
|
1419
|
+
<h3>Deprecated</h3><p>Use <code>releaseTrigger: ReleaseTrigger.scheduled()</code> instead</p>
|
|
1420
|
+
</div><aside class="tsd-sources">
|
|
1421
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseSchedule</p></aside></section>
|
|
1422
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTagPrefix" class="tsd-anchor"></a>
|
|
1423
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Tag<wbr/>Prefix</span><a href="#releaseTagPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1424
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Tag<wbr/>Prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1425
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add the given prefix to release tags.
|
|
1426
|
+
Useful if you are releasing on multiple branches with overlapping
|
|
1427
|
+
version numbers.</p>
|
|
1428
|
+
<p>Note: this prefix is used to detect the latest tagged version
|
|
1429
|
+
when bumping, so if you change this on a project with an existing version
|
|
1430
|
+
history, you may need to manually tag your latest release
|
|
1431
|
+
with the new prefix.</p>
|
|
1432
|
+
|
|
1433
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"v"</span>
|
|
1434
|
+
</code></pre>
|
|
1435
|
+
</div><aside class="tsd-sources">
|
|
1436
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTagPrefix</p></aside></section>
|
|
1437
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseToNpm" class="tsd-anchor"></a>
|
|
1438
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>To<wbr/>Npm</span><a href="#releaseToNpm" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1439
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>To<wbr/>Npm</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1440
|
+
<div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
1441
|
+
|
|
1442
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1443
|
+
</code></pre>
|
|
1444
|
+
</div><aside class="tsd-sources">
|
|
1445
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseToNpm</p></aside></section>
|
|
1446
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTrigger" class="tsd-anchor"></a>
|
|
1447
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Trigger</span><a href="#releaseTrigger" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1448
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Trigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ReleaseTrigger</span></div>
|
|
1449
|
+
<div class="tsd-comment tsd-typography"><p>The release trigger to use.</p>
|
|
1450
|
+
|
|
1451
|
+
<h3>Default</h3><ul>
|
|
1452
|
+
<li>Continuous releases (<code>ReleaseTrigger.continuous()</code>)</li>
|
|
1453
|
+
</ul>
|
|
1454
|
+
</div><aside class="tsd-sources">
|
|
1455
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTrigger</p></aside></section>
|
|
1456
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflow" class="tsd-anchor"></a>
|
|
1457
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Workflow</span><a href="#releaseWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1458
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1459
|
+
<div class="tsd-comment tsd-typography"><p>DEPRECATED: renamed to <code>release</code>.</p>
|
|
1460
|
+
|
|
1461
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> </span><span class="hl-3">subproject</span>
|
|
1462
|
+
</code></pre>
|
|
1463
|
+
|
|
1464
|
+
<h3>Deprecated</h3><p>see <code>release</code>.</p>
|
|
1465
|
+
</div><aside class="tsd-sources">
|
|
1466
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflow</p></aside></section>
|
|
1467
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowName" class="tsd-anchor"></a>
|
|
1468
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Workflow<wbr/>Name</span><a href="#releaseWorkflowName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1469
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Workflow<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1470
|
+
<div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
1471
|
+
|
|
1472
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"Release"</span>
|
|
1473
|
+
</code></pre>
|
|
1474
|
+
</div><aside class="tsd-sources">
|
|
1475
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowName</p></aside></section>
|
|
1476
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowSetupSteps" class="tsd-anchor"></a>
|
|
1477
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><a href="#releaseWorkflowSetupSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1478
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1479
|
+
<div class="tsd-comment tsd-typography"><p>A set of workflow steps to execute in order to setup the workflow
|
|
1480
|
+
container.</p>
|
|
1481
|
+
</div><aside class="tsd-sources">
|
|
1482
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowSetupSteps</p></aside></section>
|
|
1483
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebot" class="tsd-anchor"></a>
|
|
1484
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>renovatebot</span><a href="#renovatebot" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1485
|
+
<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>
|
|
1486
|
+
<div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
1487
|
+
|
|
1488
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1489
|
+
</code></pre>
|
|
1490
|
+
</div><aside class="tsd-sources">
|
|
1491
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebot</p></aside></section>
|
|
1492
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebotOptions" class="tsd-anchor"></a>
|
|
1493
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>renovatebot<wbr/>Options</span><a href="#renovatebotOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1494
|
+
<div class="tsd-signature"><span class="tsd-kind-property">renovatebot<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">RenovatebotOptions</span></div>
|
|
1495
|
+
<div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
1496
|
+
|
|
1497
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1498
|
+
</code></pre>
|
|
1499
|
+
</div><aside class="tsd-sources">
|
|
1500
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebotOptions</p></aside></section>
|
|
1501
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repository" class="tsd-anchor"></a>
|
|
1502
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>repository</span><a href="#repository" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1503
|
+
<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>
|
|
1504
|
+
<div class="tsd-comment tsd-typography"><p>The repository is the location where the actual code for your package lives.
|
|
1505
|
+
See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-repository">https://classic.yarnpkg.com/en/docs/package-json/#toc-repository</a></p>
|
|
1506
|
+
</div><aside class="tsd-sources">
|
|
1507
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repository</p></aside></section>
|
|
1508
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repositoryDirectory" class="tsd-anchor"></a>
|
|
1509
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>repository<wbr/>Directory</span><a href="#repositoryDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1510
|
+
<div class="tsd-signature"><span class="tsd-kind-property">repository<wbr/>Directory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1511
|
+
<div class="tsd-comment tsd-typography"><p>If the package.json for your package is not in the root directory (for example if it is part of a monorepo),
|
|
1512
|
+
you can specify the directory in which it lives.</p>
|
|
1513
|
+
</div><aside class="tsd-sources">
|
|
1514
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repositoryDirectory</p></aside></section>
|
|
1515
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="requireApproval" class="tsd-anchor"></a>
|
|
1516
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>require<wbr/>Approval</span><a href="#requireApproval" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1517
|
+
<div class="tsd-signature"><span class="tsd-kind-property">require<wbr/>Approval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ApprovalLevel</span></div>
|
|
1518
|
+
<div class="tsd-comment tsd-typography"><p>To protect you against unintended changes that affect your security posture,
|
|
1519
|
+
the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.</p>
|
|
1520
|
+
|
|
1521
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">ApprovalLevel</span><span class="hl-0">.</span><span class="hl-5">BROADENING</span>
|
|
1522
|
+
</code></pre>
|
|
1523
|
+
</div><aside class="tsd-sources">
|
|
1524
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.requireApproval</p></aside></section>
|
|
1525
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sampleCode" class="tsd-anchor"></a>
|
|
1526
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>sample<wbr/>Code</span><a href="#sampleCode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1527
|
+
<div class="tsd-signature"><span class="tsd-kind-property">sample<wbr/>Code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1528
|
+
<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>
|
|
1529
|
+
|
|
1530
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1531
|
+
</code></pre>
|
|
1532
|
+
</div><aside class="tsd-sources">
|
|
1533
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.sampleCode</p></aside></section>
|
|
1534
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scopedPackagesOptions" class="tsd-anchor"></a>
|
|
1535
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>scoped<wbr/>Packages<wbr/>Options</span><a href="#scopedPackagesOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1536
|
+
<div class="tsd-signature"><span class="tsd-kind-property">scoped<wbr/>Packages<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1537
|
+
<div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages</p>
|
|
1538
|
+
|
|
1539
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">fetch</span><span class="hl-0"> </span><span class="hl-3">all</span><span class="hl-0"> </span><span class="hl-3">scoped</span><span class="hl-0"> </span><span class="hl-3">packages</span><span class="hl-0"> </span><span class="hl-3">from</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">public</span><span class="hl-0"> </span><span class="hl-3">npm</span><span class="hl-0"> </span><span class="hl-3">registry</span>
|
|
1540
|
+
</code></pre>
|
|
1541
|
+
</div><aside class="tsd-sources">
|
|
1542
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scopedPackagesOptions</p></aside></section>
|
|
1543
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scripts" class="tsd-anchor"></a>
|
|
1544
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">scripts</span><a href="#scripts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1545
|
+
<div class="tsd-signature"><span class="tsd-kind-property">scripts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</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><br/><span class="tsd-signature-symbol">}</span></div>
|
|
1546
|
+
<div class="tsd-comment tsd-typography"><p>npm scripts to include. If a script has the same name as a standard script,
|
|
1547
|
+
the standard script will be overwritten.
|
|
1548
|
+
Also adds the script as a task.</p>
|
|
1549
|
+
|
|
1550
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">{}</span>
|
|
1551
|
+
</code></pre>
|
|
1552
|
+
|
|
1553
|
+
<h3>Deprecated</h3><p>use <code>project.addTask()</code> or <code>package.setScript()</code></p>
|
|
1554
|
+
</div>
|
|
1555
|
+
<div class="tsd-type-declaration">
|
|
1556
|
+
<h4>Type declaration</h4>
|
|
1557
|
+
<ul class="tsd-parameters">
|
|
1558
|
+
<li class="tsd-parameter-index-signature">
|
|
1559
|
+
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
|
|
1560
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scripts</p></aside></section>
|
|
1561
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="srcdir" class="tsd-anchor"></a>
|
|
1562
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1563
|
+
<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>
|
|
1564
|
+
<div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
1565
|
+
|
|
1566
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"src"</span>
|
|
1567
|
+
</code></pre>
|
|
1568
|
+
</div><aside class="tsd-sources">
|
|
1569
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.srcdir</p></aside></section>
|
|
1570
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stability" class="tsd-anchor"></a>
|
|
1571
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stability</span><a href="#stability" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1572
|
+
<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>
|
|
1573
|
+
<div class="tsd-comment tsd-typography"><p>Package's Stability</p>
|
|
1574
|
+
</div><aside class="tsd-sources">
|
|
1575
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stability</p></aside></section>
|
|
1576
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stale" class="tsd-anchor"></a>
|
|
1577
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stale</span><a href="#stale" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1578
|
+
<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>
|
|
1579
|
+
<div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request. See <code>staleOptions</code> for options.</p>
|
|
1580
|
+
|
|
1581
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1582
|
+
</code></pre>
|
|
1583
|
+
</div><aside class="tsd-sources">
|
|
1584
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stale</p></aside></section>
|
|
1585
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="staleOptions" class="tsd-anchor"></a>
|
|
1586
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stale<wbr/>Options</span><a href="#staleOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1587
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stale<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">StaleOptions</span></div>
|
|
1588
|
+
<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>
|
|
1589
|
+
|
|
1590
|
+
<h3>Default</h3><ul>
|
|
1591
|
+
<li>see defaults in <code>StaleOptions</code></li>
|
|
1592
|
+
</ul>
|
|
1593
|
+
</div><aside class="tsd-sources">
|
|
1594
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.staleOptions</p></aside></section>
|
|
1595
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testdir" class="tsd-anchor"></a>
|
|
1596
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>testdir</span><a href="#testdir" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1597
|
+
<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>
|
|
1598
|
+
<div class="tsd-comment tsd-typography"><p>Jest tests directory. Tests files should be named <code>xxx.test.ts</code>.</p>
|
|
1599
|
+
<p>If this directory is under <code>srcdir</code> (e.g. <code>src/test</code>, <code>src/__tests__</code>),
|
|
1600
|
+
then tests are going to be compiled into <code>lib/</code> and executed as javascript.
|
|
1601
|
+
If the test directory is outside of <code>src</code>, then we configure jest to
|
|
1602
|
+
compile the code in-memory.</p>
|
|
1603
|
+
|
|
1604
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"test"</span>
|
|
1605
|
+
</code></pre>
|
|
1606
|
+
</div><aside class="tsd-sources">
|
|
1607
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.testdir</p></aside></section>
|
|
1608
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a>
|
|
1609
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig</span><a href="#tsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1610
|
+
<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>
|
|
1611
|
+
<div class="tsd-comment tsd-typography"><p>Custom TSConfig</p>
|
|
1612
|
+
|
|
1613
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1614
|
+
</code></pre>
|
|
1615
|
+
</div><aside class="tsd-sources">
|
|
1616
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfig</p></aside></section>
|
|
1617
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDev" class="tsd-anchor"></a>
|
|
1618
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev</span><a href="#tsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1619
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Dev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TypescriptConfigOptions</span></div>
|
|
1620
|
+
<div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
1621
|
+
|
|
1622
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">use</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">production</span><span class="hl-0"> </span><span class="hl-3">tsconfig</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1623
|
+
</code></pre>
|
|
1624
|
+
</div><aside class="tsd-sources">
|
|
1625
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDev</p></aside></section>
|
|
1626
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDevFile" class="tsd-anchor"></a>
|
|
1627
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev<wbr/>File</span><a href="#tsconfigDevFile" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1628
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Dev<wbr/>File</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1629
|
+
<div class="tsd-comment tsd-typography"><p>The name of the development tsconfig.json file.</p>
|
|
1630
|
+
|
|
1631
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"tsconfig.dev.json"</span>
|
|
1632
|
+
</code></pre>
|
|
1633
|
+
</div><aside class="tsd-sources">
|
|
1634
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDevFile</p></aside></section>
|
|
1635
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="typescriptVersion" class="tsd-anchor"></a>
|
|
1636
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>typescript<wbr/>Version</span><a href="#typescriptVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1637
|
+
<div class="tsd-signature"><span class="tsd-kind-property">typescript<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1638
|
+
<div class="tsd-comment tsd-typography"><p>TypeScript version to use.</p>
|
|
1639
|
+
<p>NOTE: Typescript is not semantically versioned and should remain on the
|
|
1640
|
+
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
1641
|
+
|
|
1642
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"latest"</span>
|
|
1643
|
+
</code></pre>
|
|
1644
|
+
</div><aside class="tsd-sources">
|
|
1645
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.typescriptVersion</p></aside></section>
|
|
1646
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="versionrcOptions" class="tsd-anchor"></a>
|
|
1647
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>versionrc<wbr/>Options</span><a href="#versionrcOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1648
|
+
<div class="tsd-signature"><span class="tsd-kind-property">versionrc<wbr/>Options</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>
|
|
1649
|
+
<div class="tsd-comment tsd-typography"><p>Custom configuration used when creating changelog with standard-version package.
|
|
1650
|
+
Given values either append to default configuration or overwrite values in it.</p>
|
|
1651
|
+
|
|
1652
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">standard</span><span class="hl-0"> </span><span class="hl-3">configuration</span><span class="hl-0"> </span><span class="hl-3">applicable</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-3">GitHub</span><span class="hl-0"> </span><span class="hl-3">repositories</span>
|
|
1653
|
+
</code></pre>
|
|
1654
|
+
</div><aside class="tsd-sources">
|
|
1655
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.versionrcOptions</p></aside></section>
|
|
1656
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a>
|
|
1657
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1658
|
+
<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>
|
|
1659
|
+
<div class="tsd-comment tsd-typography"><p>Enable VSCode integration.</p>
|
|
1660
|
+
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
1661
|
+
|
|
1662
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1663
|
+
</code></pre>
|
|
1664
|
+
</div><aside class="tsd-sources">
|
|
1665
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.vscode</p></aside></section>
|
|
1666
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchExcludes" class="tsd-anchor"></a>
|
|
1667
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Excludes</span><a href="#watchExcludes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1668
|
+
<div class="tsd-signature"><span class="tsd-kind-property">watch<wbr/>Excludes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1669
|
+
<div class="tsd-comment tsd-typography"><p>Glob patterns to exclude from <code>cdk watch</code>.</p>
|
|
1670
|
+
|
|
1671
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1672
|
+
</code></pre>
|
|
1673
|
+
</div><aside class="tsd-sources">
|
|
1674
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchExcludes</p></aside></section>
|
|
1675
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchIncludes" class="tsd-anchor"></a>
|
|
1676
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Includes</span><a href="#watchIncludes" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1677
|
+
<div class="tsd-signature"><span class="tsd-kind-property">watch<wbr/>Includes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1678
|
+
<div class="tsd-comment tsd-typography"><p>Glob patterns to include in <code>cdk watch</code>.</p>
|
|
1679
|
+
|
|
1680
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1681
|
+
</code></pre>
|
|
1682
|
+
</div><aside class="tsd-sources">
|
|
1683
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchIncludes</p></aside></section>
|
|
1684
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowBootstrapSteps" class="tsd-anchor"></a>
|
|
1685
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowBootstrapSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1686
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Bootstrap<wbr/>Steps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1687
|
+
<div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
1688
|
+
|
|
1689
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
1690
|
+
</code></pre>
|
|
1691
|
+
</div><aside class="tsd-sources">
|
|
1692
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowBootstrapSteps</p></aside></section>
|
|
1693
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowContainerImage" class="tsd-anchor"></a>
|
|
1694
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Container<wbr/>Image</span><a href="#workflowContainerImage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1695
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Container<wbr/>Image</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1696
|
+
<div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
1697
|
+
|
|
1698
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">image</span>
|
|
1699
|
+
</code></pre>
|
|
1700
|
+
</div><aside class="tsd-sources">
|
|
1701
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowContainerImage</p></aside></section>
|
|
1702
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowGitIdentity" class="tsd-anchor"></a>
|
|
1703
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Git<wbr/>Identity</span><a href="#workflowGitIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1704
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Git<wbr/>Identity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GitIdentity</span></div>
|
|
1705
|
+
<div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
1706
|
+
|
|
1707
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">GitHub</span><span class="hl-0"> </span><span class="hl-3">Actions</span>
|
|
1708
|
+
</code></pre>
|
|
1709
|
+
</div><aside class="tsd-sources">
|
|
1710
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowGitIdentity</p></aside></section>
|
|
1711
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowNodeVersion" class="tsd-anchor"></a>
|
|
1712
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Node<wbr/>Version</span><a href="#workflowNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1713
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1714
|
+
<div class="tsd-comment tsd-typography"><p>The node version to use in GitHub workflows.</p>
|
|
1715
|
+
|
|
1716
|
+
<h3>Default</h3><ul>
|
|
1717
|
+
<li>same as <code>minNodeVersion</code></li>
|
|
1718
|
+
</ul>
|
|
1719
|
+
</div><aside class="tsd-sources">
|
|
1720
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowNodeVersion</p></aside></section>
|
|
1721
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowRunsOn" class="tsd-anchor"></a>
|
|
1722
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Runs<wbr/>On</span><a href="#workflowRunsOn" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
1723
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Runs<wbr/>On</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1724
|
+
<div class="tsd-comment tsd-typography"><p>Github Runner selection labels</p>
|
|
1725
|
+
|
|
1726
|
+
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[</span><span class="hl-1">"ubuntu-latest"</span><span class="hl-0">]</span>
|
|
1727
|
+
</code></pre>
|
|
1728
|
+
</div><aside class="tsd-sources">
|
|
1729
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowRunsOn</p></aside></section></section></div>
|
|
1730
|
+
<div class="col-sidebar">
|
|
1731
|
+
<div class="page-menu">
|
|
1732
|
+
<div class="tsd-navigation settings">
|
|
1733
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1734
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
1735
|
+
<div class="tsd-accordion-details">
|
|
1736
|
+
<div class="tsd-filter-visibility">
|
|
1737
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1738
|
+
<ul id="tsd-filter-options">
|
|
1739
|
+
<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>
|
|
1740
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><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>Private</span></label></li>
|
|
1741
|
+
<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>
|
|
1742
|
+
<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></form></div>
|
|
1743
|
+
<div class="tsd-theme-toggle">
|
|
1744
|
+
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1745
|
+
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1746
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>On This Page</h3></summary>
|
|
1747
|
+
<div class="tsd-accordion-details">
|
|
1748
|
+
<ul>
|
|
1749
|
+
<li><a href="#allowLibraryDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a></li>
|
|
1750
|
+
<li><a href="#appEntrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>app<wbr/>Entrypoint</span></a></li>
|
|
1751
|
+
<li><a href="#artifactsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>artifacts<wbr/>Directory</span></a></li>
|
|
1752
|
+
<li><a href="#authorEmail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Email</span></a></li>
|
|
1753
|
+
<li><a href="#authorName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Name</span></a></li>
|
|
1754
|
+
<li><a href="#authorOrganization" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Organization</span></a></li>
|
|
1755
|
+
<li><a href="#authorUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>author<wbr/>Url</span></a></li>
|
|
1756
|
+
<li><a href="#autoApproveOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Approve<wbr/>Options</span></a></li>
|
|
1757
|
+
<li><a href="#autoApproveUpgrades" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Approve<wbr/>Upgrades</span></a></li>
|
|
1758
|
+
<li><a href="#autoDetectBin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Detect<wbr/>Bin</span></a></li>
|
|
1759
|
+
<li><a href="#autoMerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Merge</span></a></li>
|
|
1760
|
+
<li><a href="#autoMergeOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Merge<wbr/>Options</span></a></li>
|
|
1761
|
+
<li><a href="#bin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bin</span></a></li>
|
|
1762
|
+
<li><a href="#bugsEmail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bugs<wbr/>Email</span></a></li>
|
|
1763
|
+
<li><a href="#bugsUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bugs<wbr/>Url</span></a></li>
|
|
1764
|
+
<li><a href="#buildCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>build<wbr/>Command</span></a></li>
|
|
1765
|
+
<li><a href="#buildWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>build<wbr/>Workflow</span></a></li>
|
|
1766
|
+
<li><a href="#buildWorkflowTriggers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>build<wbr/>Workflow<wbr/>Triggers</span></a></li>
|
|
1767
|
+
<li><a href="#bundledDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bundled<wbr/>Deps</span></a></li>
|
|
1768
|
+
<li><a href="#bundlerOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>bundler<wbr/>Options</span></a></li>
|
|
1769
|
+
<li><a href="#cdkAssert" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Assert</span></a></li>
|
|
1770
|
+
<li><a href="#cdkAssertions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Assertions</span></a></li>
|
|
1771
|
+
<li><a href="#cdkDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Dependencies</span></a></li>
|
|
1772
|
+
<li><a href="#cdkDependenciesAsDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span></a></li>
|
|
1773
|
+
<li><a href="#cdkTestDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Test<wbr/>Dependencies</span></a></li>
|
|
1774
|
+
<li><a href="#cdkVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Version</span></a></li>
|
|
1775
|
+
<li><a href="#cdkVersionPinning" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdk<wbr/>Version<wbr/>Pinning</span></a></li>
|
|
1776
|
+
<li><a href="#cdkout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>cdkout</span></a></li>
|
|
1777
|
+
<li><a href="#clobber" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>clobber</span></a></li>
|
|
1778
|
+
<li><a href="#codeArtifactOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>code<wbr/>Artifact<wbr/>Options</span></a></li>
|
|
1779
|
+
<li><a href="#codeCov" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>code<wbr/>Cov</span></a></li>
|
|
1780
|
+
<li><a href="#codeCovTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span></a></li>
|
|
1781
|
+
<li><a href="#commitGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>commit<wbr/>Generated</span></a></li>
|
|
1782
|
+
<li><a href="#constructsVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>constructs<wbr/>Version</span></a></li>
|
|
1783
|
+
<li><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>context</span></a></li>
|
|
1784
|
+
<li><a href="#copyrightOwner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>copyright<wbr/>Owner</span></a></li>
|
|
1785
|
+
<li><a href="#copyrightPeriod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>copyright<wbr/>Period</span></a></li>
|
|
1786
|
+
<li><a href="#defaultReleaseBranch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a></li>
|
|
1787
|
+
<li><a href="#dependabot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dependabot</span></a></li>
|
|
1788
|
+
<li><a href="#dependabotOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dependabot<wbr/>Options</span></a></li>
|
|
1789
|
+
<li><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>deps</span></a></li>
|
|
1790
|
+
<li><a href="#depsUpgrade" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>deps<wbr/>Upgrade</span></a></li>
|
|
1791
|
+
<li><a href="#depsUpgradeOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>deps<wbr/>Upgrade<wbr/>Options</span></a></li>
|
|
1792
|
+
<li><a href="#description" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>description</span></a></li>
|
|
1793
|
+
<li><a href="#devContainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dev<wbr/>Container</span></a></li>
|
|
1794
|
+
<li><a href="#devDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>dev<wbr/>Deps</span></a></li>
|
|
1795
|
+
<li><a href="#disableTsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>disable<wbr/>Tsconfig</span></a></li>
|
|
1796
|
+
<li><a href="#disableTsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev</span></a></li>
|
|
1797
|
+
<li><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>docgen</span></a></li>
|
|
1798
|
+
<li><a href="#docsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>docs<wbr/>Directory</span></a></li>
|
|
1799
|
+
<li><a href="#edgeLambdaAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1800
|
+
<li><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>entrypoint</span></a></li>
|
|
1801
|
+
<li><a href="#entrypointTypes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>entrypoint<wbr/>Types</span></a></li>
|
|
1802
|
+
<li><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>eslint</span></a></li>
|
|
1803
|
+
<li><a href="#eslintOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>eslint<wbr/>Options</span></a></li>
|
|
1804
|
+
<li><a href="#featureFlags" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>feature<wbr/>Flags</span></a></li>
|
|
1805
|
+
<li><a href="#gitIgnoreOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>git<wbr/>Ignore<wbr/>Options</span></a></li>
|
|
1806
|
+
<li><a href="#gitOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>git<wbr/>Options</span></a></li>
|
|
1807
|
+
<li><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>github</span></a></li>
|
|
1808
|
+
<li><a href="#githubOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>github<wbr/>Options</span></a></li>
|
|
1809
|
+
<li><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>gitignore</span></a></li>
|
|
1810
|
+
<li><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>gitpod</span></a></li>
|
|
1811
|
+
<li><a href="#homepage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>homepage</span></a></li>
|
|
1812
|
+
<li><a href="#integrationTestAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1813
|
+
<li><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>jest</span></a></li>
|
|
1814
|
+
<li><a href="#jestOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>jest<wbr/>Options</span></a></li>
|
|
1815
|
+
<li><a href="#jsiiReleaseVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>jsii<wbr/>Release<wbr/>Version</span></a></li>
|
|
1816
|
+
<li><a href="#keywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>keywords</span></a></li>
|
|
1817
|
+
<li><a href="#lambdaAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>lambda<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1818
|
+
<li><a href="#lambdaExtensionAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1819
|
+
<li><a href="#lambdaOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>lambda<wbr/>Options</span></a></li>
|
|
1820
|
+
<li><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>libdir</span></a></li>
|
|
1821
|
+
<li><a href="#license" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>license</span></a></li>
|
|
1822
|
+
<li><a href="#licensed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>licensed</span></a></li>
|
|
1823
|
+
<li><a href="#logging" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>logging</span></a></li>
|
|
1824
|
+
<li><a href="#majorVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>major<wbr/>Version</span></a></li>
|
|
1825
|
+
<li><a href="#maxNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a></li>
|
|
1826
|
+
<li><a href="#mergify" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mergify</span></a></li>
|
|
1827
|
+
<li><a href="#mergifyOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mergify<wbr/>Options</span></a></li>
|
|
1828
|
+
<li><a href="#minMajorVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>min<wbr/>Major<wbr/>Version</span></a></li>
|
|
1829
|
+
<li><a href="#minNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a></li>
|
|
1830
|
+
<li><a href="#mutableBuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>mutable<wbr/>Build</span></a></li>
|
|
1831
|
+
<li><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a></li>
|
|
1832
|
+
<li><a href="#npmAccess" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Access</span></a></li>
|
|
1833
|
+
<li><a href="#npmDistTag" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Dist<wbr/>Tag</span></a></li>
|
|
1834
|
+
<li><a href="#npmIgnoreOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Ignore<wbr/>Options</span></a></li>
|
|
1835
|
+
<li><a href="#npmRegistry" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Registry</span></a></li>
|
|
1836
|
+
<li><a href="#npmRegistryUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Registry<wbr/>Url</span></a></li>
|
|
1837
|
+
<li><a href="#npmTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npm<wbr/>Token<wbr/>Secret</span></a></li>
|
|
1838
|
+
<li><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npmignore</span></a></li>
|
|
1839
|
+
<li><a href="#npmignoreEnabled" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>npmignore<wbr/>Enabled</span></a></li>
|
|
1840
|
+
<li><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>outdir</span></a></li>
|
|
1841
|
+
<li><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>package</span></a></li>
|
|
1842
|
+
<li><a href="#packageManager" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>package<wbr/>Manager</span></a></li>
|
|
1843
|
+
<li><a href="#packageName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>package<wbr/>Name</span></a></li>
|
|
1844
|
+
<li><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>parent</span></a></li>
|
|
1845
|
+
<li><a href="#peerDependencyOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>peer<wbr/>Dependency<wbr/>Options</span></a></li>
|
|
1846
|
+
<li><a href="#peerDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>peer<wbr/>Deps</span></a></li>
|
|
1847
|
+
<li><a href="#pnpmVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pnpm<wbr/>Version</span></a></li>
|
|
1848
|
+
<li><a href="#postBuildSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>post<wbr/>Build<wbr/>Steps</span></a></li>
|
|
1849
|
+
<li><a href="#prerelease" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prerelease</span></a></li>
|
|
1850
|
+
<li><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prettier</span></a></li>
|
|
1851
|
+
<li><a href="#prettierOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prettier<wbr/>Options</span></a></li>
|
|
1852
|
+
<li><a href="#projectType" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>project<wbr/>Type</span></a></li>
|
|
1853
|
+
<li><a href="#projenCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Command</span></a></li>
|
|
1854
|
+
<li><a href="#projenCredentials" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Credentials</span></a></li>
|
|
1855
|
+
<li><a href="#projenDevDependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Dev<wbr/>Dependency</span></a></li>
|
|
1856
|
+
<li><a href="#projenTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Token<wbr/>Secret</span></a></li>
|
|
1857
|
+
<li><a href="#projenVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projen<wbr/>Version</span></a></li>
|
|
1858
|
+
<li><a href="#projenrcJs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Js</span></a></li>
|
|
1859
|
+
<li><a href="#projenrcJsOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Js<wbr/>Options</span></a></li>
|
|
1860
|
+
<li><a href="#projenrcJson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Json</span></a></li>
|
|
1861
|
+
<li><a href="#projenrcJsonOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Json<wbr/>Options</span></a></li>
|
|
1862
|
+
<li><a href="#projenrcTs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Ts</span></a></li>
|
|
1863
|
+
<li><a href="#projenrcTsOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options</span></a></li>
|
|
1864
|
+
<li><a href="#publishDryRun" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>publish<wbr/>Dry<wbr/>Run</span></a></li>
|
|
1865
|
+
<li><a href="#publishTasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>publish<wbr/>Tasks</span></a></li>
|
|
1866
|
+
<li><a href="#pullRequestTemplate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a></li>
|
|
1867
|
+
<li><a href="#pullRequestTemplateContents" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a></li>
|
|
1868
|
+
<li><a href="#readme" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>readme</span></a></li>
|
|
1869
|
+
<li><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release</span></a></li>
|
|
1870
|
+
<li><a href="#releaseBranches" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Branches</span></a></li>
|
|
1871
|
+
<li><a href="#releaseEveryCommit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Every<wbr/>Commit</span></a></li>
|
|
1872
|
+
<li><a href="#releaseFailureIssue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Failure<wbr/>Issue</span></a></li>
|
|
1873
|
+
<li><a href="#releaseFailureIssueLabel" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span></a></li>
|
|
1874
|
+
<li><a href="#releaseSchedule" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Schedule</span></a></li>
|
|
1875
|
+
<li><a href="#releaseTagPrefix" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Tag<wbr/>Prefix</span></a></li>
|
|
1876
|
+
<li><a href="#releaseToNpm" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>To<wbr/>Npm</span></a></li>
|
|
1877
|
+
<li><a href="#releaseTrigger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Trigger</span></a></li>
|
|
1878
|
+
<li><a href="#releaseWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Workflow</span></a></li>
|
|
1879
|
+
<li><a href="#releaseWorkflowName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Workflow<wbr/>Name</span></a></li>
|
|
1880
|
+
<li><a href="#releaseWorkflowSetupSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span></a></li>
|
|
1881
|
+
<li><a href="#renovatebot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>renovatebot</span></a></li>
|
|
1882
|
+
<li><a href="#renovatebotOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>renovatebot<wbr/>Options</span></a></li>
|
|
1883
|
+
<li><a href="#repository" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>repository</span></a></li>
|
|
1884
|
+
<li><a href="#repositoryDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>repository<wbr/>Directory</span></a></li>
|
|
1885
|
+
<li><a href="#requireApproval" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>require<wbr/>Approval</span></a></li>
|
|
1886
|
+
<li><a href="#sampleCode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>sample<wbr/>Code</span></a></li>
|
|
1887
|
+
<li><a href="#scopedPackagesOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>scoped<wbr/>Packages<wbr/>Options</span></a></li>
|
|
1888
|
+
<li><a href="#scripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>scripts</span></a></li>
|
|
1889
|
+
<li><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>srcdir</span></a></li>
|
|
1890
|
+
<li><a href="#stability" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stability</span></a></li>
|
|
1891
|
+
<li><a href="#stale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stale</span></a></li>
|
|
1892
|
+
<li><a href="#staleOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stale<wbr/>Options</span></a></li>
|
|
1893
|
+
<li><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>testdir</span></a></li>
|
|
1894
|
+
<li><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tsconfig</span></a></li>
|
|
1895
|
+
<li><a href="#tsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tsconfig<wbr/>Dev</span></a></li>
|
|
1896
|
+
<li><a href="#tsconfigDevFile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>tsconfig<wbr/>Dev<wbr/>File</span></a></li>
|
|
1897
|
+
<li><a href="#typescriptVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>typescript<wbr/>Version</span></a></li>
|
|
1898
|
+
<li><a href="#versionrcOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>versionrc<wbr/>Options</span></a></li>
|
|
1899
|
+
<li><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>vscode</span></a></li>
|
|
1900
|
+
<li><a href="#watchExcludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>watch<wbr/>Excludes</span></a></li>
|
|
1901
|
+
<li><a href="#watchIncludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>watch<wbr/>Includes</span></a></li>
|
|
1902
|
+
<li><a href="#workflowBootstrapSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a></li>
|
|
1903
|
+
<li><a href="#workflowContainerImage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Container<wbr/>Image</span></a></li>
|
|
1904
|
+
<li><a href="#workflowGitIdentity" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Git<wbr/>Identity</span></a></li>
|
|
1905
|
+
<li><a href="#workflowNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Node<wbr/>Version</span></a></li>
|
|
1906
|
+
<li><a href="#workflowRunsOn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workflow<wbr/>Runs<wbr/>On</span></a></li></ul></div></details></div>
|
|
1907
|
+
<div class="site-menu">
|
|
1908
|
+
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4-path"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)" id="icon-4-text"></path></svg><span>cdk-<wbr/>serverless</span></a>
|
|
1909
|
+
<ul class="tsd-small-nested-navigation">
|
|
1910
|
+
<li><a href="../classes/Datastore.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Datastore</span></a></li>
|
|
1911
|
+
<li><a href="../classes/RestApi.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
1912
|
+
<li><a href="../classes/ServerlessProject.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
1913
|
+
<li><a href="../classes/Workflow.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Workflow</span></a></li>
|
|
1914
|
+
<li><a href="DatastoreOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Datastore<wbr/>Options</span></a></li>
|
|
1915
|
+
<li><a href="RestApiOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Rest<wbr/>Api<wbr/>Options</span></a></li>
|
|
1916
|
+
<li><a href="ServerlessProjectOptions.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Serverless<wbr/>Project<wbr/>Options</span></a></li>
|
|
1917
|
+
<li><a href="WorkflowOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Workflow<wbr/>Options</span></a></li>
|
|
1918
|
+
<li><a href="../variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg><span>PACKAGE_<wbr/>NAME</span></a></li></ul></nav></div></div></div>
|
|
1919
|
+
<div class="tsd-generator">
|
|
1920
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1921
|
+
<div class="overlay"></div></body></html>
|