cdk-serverless 3.3.2 → 3.4.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/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-233633-review.md +98 -0
- package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-234937-review.md +86 -0
- package/.agents/tasks/task-dependency-cve-upgrade/context.json +24 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-001.json +28 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-002.json +33 -0
- package/.agents/tasks/task-dependency-cve-upgrade/task.json +7 -0
- package/docs/constructs/assets/hierarchy.js +1 -1
- package/docs/constructs/assets/highlight.css +1 -1
- package/docs/constructs/assets/main.js +1 -1
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +18 -3
- package/docs/constructs/classes/AssetCdn.html +161 -20
- package/docs/constructs/classes/BaseApi.html +153 -13
- package/docs/constructs/classes/CognitoAuthentication.html +188 -22
- package/docs/constructs/classes/GraphQlApi.html +349 -23
- package/docs/constructs/classes/LambdaFunction.html +1074 -106
- package/docs/constructs/classes/McpAuth.html +152 -16
- package/docs/constructs/classes/McpCognitoAuth.html +152 -16
- package/docs/constructs/classes/RestApi.html +344 -37
- package/docs/constructs/classes/SingleTableDatastore.html +173 -19
- package/docs/constructs/classes/Workflow.html +170 -21
- package/docs/constructs/hierarchy.html +47 -1
- package/docs/constructs/index.html +75 -2
- package/docs/constructs/interfaces/AssetCdnProps.html +61 -5
- package/docs/constructs/interfaces/BaseApiProps.html +141 -20
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +135 -20
- package/docs/constructs/interfaces/GraphQlApiProps.html +185 -22
- package/docs/constructs/interfaces/ICognitoAuthentication.html +57 -3
- package/docs/constructs/interfaces/IJwtAuthentication.html +63 -5
- package/docs/constructs/interfaces/ISingleTableDatastore.html +57 -3
- package/docs/constructs/interfaces/JsResolverOptions.html +66 -6
- package/docs/constructs/interfaces/LambdaFunctionProps.html +126 -18
- package/docs/constructs/interfaces/LambdaTracingOptions.html +57 -4
- package/docs/constructs/interfaces/McpAuthCognitoOptions.html +75 -8
- package/docs/constructs/interfaces/McpAuthFunctions.html +76 -8
- package/docs/constructs/interfaces/McpAuthGenericOptions.html +66 -6
- package/docs/constructs/interfaces/McpAuthOptions.html +107 -15
- package/docs/constructs/interfaces/McpAuthProps.html +123 -18
- package/docs/constructs/interfaces/McpCognitoAuthProps.html +127 -19
- package/docs/constructs/interfaces/RestApiProps.html +237 -37
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +77 -9
- package/docs/constructs/interfaces/SingleTableDesign.html +72 -7
- package/docs/constructs/interfaces/VtlResolverOptions.html +62 -5
- package/docs/constructs/interfaces/WorkflowProps.html +63 -2
- package/docs/constructs/modules.html +44 -1
- package/docs/constructs/types/LambdaOptions.html +31 -1
- package/docs/experiments/appsync-unit-resolver-error-probe.md +201 -0
- package/docs/lambda/assets/hierarchy.js +1 -1
- package/docs/lambda/assets/highlight.css +1 -1
- package/docs/lambda/assets/main.js +1 -1
- package/docs/lambda/assets/navigation.js +1 -1
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +18 -3
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +247 -20
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +246 -20
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +242 -21
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +235 -20
- package/docs/lambda/classes/auth.JwtAuthorizer.html +225 -20
- package/docs/lambda/classes/errors.BadRequestError.html +147 -11
- package/docs/lambda/classes/errors.ForbiddenError.html +147 -11
- package/docs/lambda/classes/errors.HttpError.html +154 -12
- package/docs/lambda/classes/errors.NotFoundError.html +147 -11
- package/docs/lambda/classes/errors.UnauthenticatedError.html +147 -11
- package/docs/lambda/classes/errors.appsync.AppSyncError.html +193 -0
- package/docs/lambda/classes/errors.appsync.ConflictError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ForbiddenError.html +184 -0
- package/docs/lambda/classes/errors.appsync.NotFoundError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ValidationError.html +184 -0
- package/docs/lambda/functions/api.createAppSyncHandler.html +50 -3
- package/docs/lambda/functions/api.createHttpHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +47 -2
- package/docs/lambda/hierarchy.html +59 -1
- package/docs/lambda/index.html +75 -2
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +68 -3
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +67 -3
- package/docs/lambda/interfaces/api.HttpResponseContext.html +61 -3
- package/docs/lambda/interfaces/api.Operation.html +61 -3
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +65 -3
- package/docs/lambda/modules/api.html +45 -1
- package/docs/lambda/modules/auth.html +37 -1
- package/docs/lambda/modules/errors.appsync.html +38 -0
- package/docs/lambda/modules/errors.html +41 -1
- package/docs/lambda/modules.html +36 -1
- package/docs/lambda/types/api.APIGatewayv1Handler.html +34 -2
- package/docs/lambda/types/api.AppSyncHandler.html +51 -2
- package/docs/lambda/types/api.HttpHandler.html +52 -2
- package/docs/projen/assets/highlight.css +5 -12
- package/docs/projen/assets/main.js +1 -1
- package/docs/projen/assets/style.css +18 -3
- package/docs/projen/classes/Datastore.html +254 -18
- package/docs/projen/classes/GraphQlApi.html +238 -18
- package/docs/projen/classes/RestApi.html +325 -40
- package/docs/projen/classes/ServerlessProject.html +1021 -159
- package/docs/projen/classes/Workflow.html +288 -31
- package/docs/projen/hierarchy.html +29 -1
- package/docs/projen/index.html +75 -2
- package/docs/projen/interfaces/DatastoreOptions.html +54 -2
- package/docs/projen/interfaces/GraphQlApiOptions.html +54 -2
- package/docs/projen/interfaces/RestApiOptions.html +54 -2
- package/docs/projen/interfaces/ServerlessProjectOptions.html +2089 -692
- package/docs/projen/interfaces/WorkflowOptions.html +54 -2
- package/docs/projen/modules.html +44 -1
- package/docs/projen/variables/PACKAGE_NAME.html +31 -1
- package/lib/constructs/graphql.d.ts +17 -0
- package/lib/constructs/graphql.js +78 -2
- package/lib/lambda/appsync-errors.d.ts +67 -0
- package/lib/lambda/appsync-errors.js +91 -0
- package/lib/lambda/errors.d.ts +1 -0
- package/lib/lambda/errors.js +36 -2
- package/lib/lambda/handler.js +78 -1
- package/llm.md +31 -0
- package/package.json +26 -24
|
@@ -1,11 +1,44 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerlessProject | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerlessProject | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">ServerlessProject</a></li></ul>
|
|
12
|
+
<h1>Class ServerlessProject</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>The ServerlessProject construct sets up an AWS CDK TypeScript project with serverless application dependencies and configurations.
|
|
2
15
|
This construct extends the projen AwsCdkTypeScriptApp to include additional dependencies and development dependencies required
|
|
3
16
|
for serverless applications. It also enables TypeScript projen configuration (projenrcTs).</p>
|
|
4
|
-
</div
|
|
17
|
+
</div>
|
|
18
|
+
<div class="tsd-comment tsd-typography">
|
|
19
|
+
<div class="tsd-tag-example">
|
|
20
|
+
<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">project</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">ServerlessProject</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">'MyServerlessApp'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">defaultReleaseBranch:</span><span class="hl-1"> </span><span class="hl-2">'main'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">cdkVersion:</span><span class="hl-1"> </span><span class="hl-2">'2.140.0'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">deps:</span><span class="hl-1"> [</span><span class="hl-2">'additional-dependency'</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">devDeps:</span><span class="hl-1"> [</span><span class="hl-2">'additional-dev-dependency'</span><span class="hl-1">],</span><br/><span class="hl-1">});</span>
|
|
5
21
|
</code><button type="button">Copy</button></pre>
|
|
6
22
|
|
|
7
|
-
</div></div></section
|
|
8
|
-
|
|
23
|
+
</div></div></section>
|
|
24
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="186">
|
|
25
|
+
<h4>Hierarchy</h4>
|
|
26
|
+
<ul class="tsd-hierarchy">
|
|
27
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">AwsCdkTypeScriptApp</span>
|
|
28
|
+
<ul class="tsd-hierarchy">
|
|
29
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ServerlessProject</span></li></ul></li></ul></section>
|
|
30
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
31
|
+
<section class="tsd-panel tsd-index-panel">
|
|
32
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
33
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
34
|
+
<div class="tsd-accordion-details">
|
|
35
|
+
<section class="tsd-index-section">
|
|
36
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
37
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
38
|
+
</div></section>
|
|
39
|
+
<section class="tsd-index-section">
|
|
40
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
41
|
+
<div class="tsd-index-list"><a href="#appentrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a>
|
|
9
42
|
<a href="#artifactsdirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a>
|
|
10
43
|
<a href="#artifactsjavascriptdirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a>
|
|
11
44
|
<a href="#autoapprove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve?</span></a>
|
|
@@ -27,7 +60,6 @@ for serverless applications. It also enables TypeScript projen configuration (pr
|
|
|
27
60
|
<a href="#github" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a>
|
|
28
61
|
<a href="#gitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a>
|
|
29
62
|
<a href="#gitpod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a>
|
|
30
|
-
<a href="#initproject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>init<wbr/>Project?</span></a>
|
|
31
63
|
<a href="#jest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest?</span></a>
|
|
32
64
|
<a href="#libdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a>
|
|
33
65
|
<a href="#logger" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a>
|
|
@@ -40,9 +72,8 @@ for serverless applications. It also enables TypeScript projen configuration (pr
|
|
|
40
72
|
<a href="#parent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent?</span></a>
|
|
41
73
|
<a href="#prettier" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier?</span></a>
|
|
42
74
|
<a href="#projectbuild" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Build</span></a>
|
|
43
|
-
<a href="#projecttype" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Type</span></a>
|
|
44
|
-
<a href="#publisher" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publisher?</span></a>
|
|
45
75
|
<a href="#release" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release?</span></a>
|
|
76
|
+
<a href="#runner" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runner</span></a>
|
|
46
77
|
<a href="#runscriptcommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>Script<wbr/>Command</span></a>
|
|
47
78
|
<a href="#srcdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a>
|
|
48
79
|
<a href="#tasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tasks</span></a>
|
|
@@ -57,20 +88,20 @@ for serverless applications. It also enables TypeScript projen configuration (pr
|
|
|
57
88
|
<a href="#workflowpackagecache" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a>
|
|
58
89
|
<a href="#default_task" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TASK</span></a>
|
|
59
90
|
<a href="#default_ts_jest_tranform_pattern" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span></a>
|
|
60
|
-
</div></section
|
|
61
|
-
<
|
|
91
|
+
</div></section>
|
|
92
|
+
<section class="tsd-index-section">
|
|
93
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="accessors">Accessors<a href="#accessors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
94
|
+
<div class="tsd-index-list"><a href="#buildtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Task</span></a>
|
|
62
95
|
<a href="#buildworkflowjobid" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span></a>
|
|
63
96
|
<a href="#cdkversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a>
|
|
64
97
|
<a href="#compiletask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>compile<wbr/>Task</span></a>
|
|
65
98
|
<a href="#components" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>components</span></a>
|
|
66
99
|
<a href="#ejected" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ejected</span></a>
|
|
67
|
-
<a href="#entrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>entrypoint</span></a>
|
|
68
100
|
<a href="#files" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>files</span></a>
|
|
69
|
-
<a href="#
|
|
101
|
+
<a href="#initproject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>init<wbr/>Project</span></a>
|
|
70
102
|
<a href="#maxnodeversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a>
|
|
71
103
|
<a href="#minnodeversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a>
|
|
72
104
|
<a href="#npmrc" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>npmrc</span></a>
|
|
73
|
-
<a href="#packagemanager" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Manager</span></a>
|
|
74
105
|
<a href="#packagetask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Task</span></a>
|
|
75
106
|
<a href="#postcompiletask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>post<wbr/>Compile<wbr/>Task</span></a>
|
|
76
107
|
<a href="#precompiletask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pre<wbr/>Compile<wbr/>Task</span></a>
|
|
@@ -78,10 +109,11 @@ for serverless applications. It also enables TypeScript projen configuration (pr
|
|
|
78
109
|
<a href="#root" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root</span></a>
|
|
79
110
|
<a href="#subprojects" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subprojects</span></a>
|
|
80
111
|
<a href="#testtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>test<wbr/>Task</span></a>
|
|
81
|
-
</div></section
|
|
112
|
+
</div></section>
|
|
113
|
+
<section class="tsd-index-section">
|
|
114
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
115
|
+
<div class="tsd-index-list"><a href="#addbins" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bins</span></a>
|
|
82
116
|
<a href="#addbundleddeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a>
|
|
83
|
-
<a href="#addcdkdependency" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cdk<wbr/>Dependency</span></a>
|
|
84
|
-
<a href="#addcompilecommand" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Compile<wbr/>Command</span></a>
|
|
85
117
|
<a href="#adddeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Deps</span></a>
|
|
86
118
|
<a href="#adddevdeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a>
|
|
87
119
|
<a href="#addexcludefromcleanup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a>
|
|
@@ -92,11 +124,8 @@ for serverless applications. It also enables TypeScript projen configuration (pr
|
|
|
92
124
|
<a href="#addpeerdeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a>
|
|
93
125
|
<a href="#addscripts" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a>
|
|
94
126
|
<a href="#addtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Task</span></a>
|
|
95
|
-
<a href="#addtestcommand" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a>
|
|
96
|
-
<a href="#addtip" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tip</span></a>
|
|
97
127
|
<a href="#annotategenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a>
|
|
98
128
|
<a href="#defaulttypescriptcompileroptions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>default<wbr/>Type<wbr/>Script<wbr/>Compiler<wbr/>Options</span></a>
|
|
99
|
-
<a href="#hasscript" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Script</span></a>
|
|
100
129
|
<a href="#postsynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a>
|
|
101
130
|
<a href="#presynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a>
|
|
102
131
|
<a href="#removescript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Script</span></a>
|
|
@@ -107,197 +136,965 @@ for serverless applications. It also enables TypeScript projen configuration (pr
|
|
|
107
136
|
<a href="#synth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>synth</span></a>
|
|
108
137
|
<a href="#tostring" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
109
138
|
<a href="#tryfindfile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>File</span></a>
|
|
110
|
-
<a href="#tryfindjsonfile" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Json<wbr/>File</span></a>
|
|
111
139
|
<a href="#tryfindobjectfile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Object<wbr/>File</span></a>
|
|
112
140
|
<a href="#tryremovefile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a>
|
|
113
141
|
<a href="#with" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a>
|
|
114
142
|
<a href="#isconstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
|
115
143
|
<a href="#isproject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Project</span></a>
|
|
116
144
|
<a href="#of" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>of</span></a>
|
|
117
|
-
</div></section></div></details></section></section
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
145
|
+
</div></section></div></details></section></section>
|
|
146
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
147
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
148
|
+
<section>
|
|
149
|
+
<section class="tsd-panel tsd-member">
|
|
150
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
151
|
+
<ul class="tsd-signatures">
|
|
152
|
+
<li class="">
|
|
153
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorserverlessproject"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ServerlessProject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ServerlessProjectOptions.html" class="tsd-signature-type tsd-kind-interface">ServerlessProjectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ServerlessProject</a><a href="#constructorserverlessproject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
154
|
+
<div class="tsd-description">
|
|
155
|
+
<div class="tsd-comment tsd-typography"><p>Creates an instance of ServerlessProject.</p>
|
|
156
|
+
</div>
|
|
157
|
+
<div class="tsd-parameters">
|
|
158
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
159
|
+
<ul class="tsd-parameter-list">
|
|
160
|
+
<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ServerlessProjectOptions.html" class="tsd-signature-type tsd-kind-interface">ServerlessProjectOptions</a></span>
|
|
161
|
+
<div class="tsd-comment tsd-typography"><p>The options for configuring the ServerlessProject.</p>
|
|
162
|
+
</div></li></ul></div>
|
|
163
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ServerlessProject</a></h4><aside class="tsd-sources">
|
|
164
|
+
<p>Overrides pj.awscdk.AwsCdkTypeScriptApp.constructor</p></aside></div></li></ul></section></section></details>
|
|
165
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
166
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
167
|
+
<section>
|
|
168
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
169
|
+
<h3 class="tsd-anchor-link" id="appentrypoint"><code class="tsd-tag">Readonly</code><span>app<wbr/>Entrypoint</span><a href="#appentrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
170
|
+
<div class="tsd-signature"><span class="tsd-kind-property">appEntrypoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
171
|
+
<div class="tsd-comment tsd-typography"><p>The CDK app entrypoint</p>
|
|
172
|
+
</div><aside class="tsd-sources">
|
|
173
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.appEntrypoint</p></aside></section>
|
|
174
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
175
|
+
<h3 class="tsd-anchor-link" id="artifactsdirectory"><code class="tsd-tag">Readonly</code><span>artifacts<wbr/>Directory</span><a href="#artifactsdirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
176
|
+
<div class="tsd-signature"><span class="tsd-kind-property">artifactsDirectory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
177
|
+
<div class="tsd-comment tsd-typography"><p>The build output directory. An npm tarball will be created under the <code>js</code>
|
|
121
178
|
subdirectory. For example, if this is set to <code>dist</code> (the default), the npm
|
|
122
179
|
tarball will be placed under <code>dist/js/boom-boom-1.2.3.tg</code>.</p>
|
|
123
|
-
</div><aside class="tsd-sources"
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
</div><aside class="tsd-sources"
|
|
130
|
-
|
|
180
|
+
</div><aside class="tsd-sources">
|
|
181
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsDirectory</p></aside></section>
|
|
182
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
183
|
+
<h3 class="tsd-anchor-link" id="artifactsjavascriptdirectory"><code class="tsd-tag">Readonly</code><span>artifacts<wbr/>Javascript<wbr/>Directory</span><a href="#artifactsjavascriptdirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
184
|
+
<div class="tsd-signature"><span class="tsd-kind-property">artifactsJavascriptDirectory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
185
|
+
<div class="tsd-comment tsd-typography"><p>The location of the npm tarball after build (<code>${artifactsDirectory}/js</code>).</p>
|
|
186
|
+
</div><aside class="tsd-sources">
|
|
187
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsJavascriptDirectory</p></aside></section>
|
|
188
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
189
|
+
<h3 class="tsd-anchor-link" id="autoapprove"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Approve</span><a href="#autoapprove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
190
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoApprove</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApprove</span></div>
|
|
191
|
+
<div class="tsd-comment tsd-typography"><p>Auto approve set up for this project.</p>
|
|
192
|
+
</div><aside class="tsd-sources">
|
|
193
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoApprove</p></aside></section>
|
|
194
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
195
|
+
<h3 class="tsd-anchor-link" id="automerge"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Merge</span><a href="#automerge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
196
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoMerge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMerge</span></div>
|
|
197
|
+
<div class="tsd-comment tsd-typography"><p>Component that sets up mergify for merging approved pull requests.</p>
|
|
198
|
+
</div><aside class="tsd-sources">
|
|
199
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoMerge</p></aside></section>
|
|
200
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
201
|
+
<h3 class="tsd-anchor-link" id="biome"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>biome</span><a href="#biome" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
202
|
+
<div class="tsd-signature"><span class="tsd-kind-property">biome</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Biome</span></div><aside class="tsd-sources">
|
|
203
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.biome</p></aside></section>
|
|
204
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
205
|
+
<h3 class="tsd-anchor-link" id="buildworkflow"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>build<wbr/>Workflow</span><a href="#buildworkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
206
|
+
<div class="tsd-signature"><span class="tsd-kind-property">buildWorkflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflow</span></div>
|
|
207
|
+
<div class="tsd-comment tsd-typography"><p>The PR build GitHub workflow. <code>undefined</code> if <code>buildWorkflow</code> is disabled.</p>
|
|
208
|
+
</div><aside class="tsd-sources">
|
|
209
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflow</p></aside></section>
|
|
210
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
211
|
+
<h3 class="tsd-anchor-link" id="bundler"><code class="tsd-tag">Readonly</code><span>bundler</span><a href="#bundler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
212
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bundler</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Bundler</span></div><aside class="tsd-sources">
|
|
213
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.bundler</p></aside></section>
|
|
214
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
215
|
+
<h3 class="tsd-anchor-link" id="cdkconfig"><code class="tsd-tag">Readonly</code><span>cdk<wbr/>Config</span><a href="#cdkconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
216
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdkConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CdkConfig</span></div>
|
|
217
|
+
<div class="tsd-comment tsd-typography"><p>cdk.json configuration.</p>
|
|
218
|
+
</div><aside class="tsd-sources">
|
|
219
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkConfig</p></aside></section>
|
|
220
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
221
|
+
<h3 class="tsd-anchor-link" id="cdkdeps"><code class="tsd-tag">Readonly</code><span>cdk<wbr/>Deps</span><a href="#cdkdeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
222
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdkDeps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AwsCdkDeps</span></div><aside class="tsd-sources">
|
|
223
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkDeps</p></aside></section>
|
|
224
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
225
|
+
<h3 class="tsd-anchor-link" id="cdktasks"><code class="tsd-tag">Readonly</code><span>cdk<wbr/>Tasks</span><a href="#cdktasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
226
|
+
<div class="tsd-signature"><span class="tsd-kind-property">cdkTasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CdkTasks</span></div>
|
|
227
|
+
<div class="tsd-comment tsd-typography"><p>Common CDK tasks.</p>
|
|
228
|
+
</div><aside class="tsd-sources">
|
|
229
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkTasks</p></aside></section>
|
|
230
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
231
|
+
<h3 class="tsd-anchor-link" id="commitgenerated"><code class="tsd-tag">Readonly</code><span>commit<wbr/>Generated</span><a href="#commitgenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
232
|
+
<div class="tsd-signature"><span class="tsd-kind-property">commitGenerated</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
233
|
+
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
234
|
+
</div><aside class="tsd-sources">
|
|
235
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.commitGenerated</p></aside></section>
|
|
236
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
237
|
+
<h3 class="tsd-anchor-link" id="defaulttask"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>default<wbr/>Task</span><a href="#defaulttask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
238
|
+
<div class="tsd-signature"><span class="tsd-kind-property">defaultTask</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Task</span></div>
|
|
239
|
+
<div class="tsd-comment tsd-typography"><p>This is the "default" task, the one that executes "projen". Undefined if
|
|
131
240
|
the project is being ejected.</p>
|
|
132
|
-
</div><aside class="tsd-sources"
|
|
133
|
-
|
|
241
|
+
</div><aside class="tsd-sources">
|
|
242
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.defaultTask</p></aside></section>
|
|
243
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
244
|
+
<h3 class="tsd-anchor-link" id="deps"><code class="tsd-tag">Readonly</code><span>deps</span><a href="#deps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
245
|
+
<div class="tsd-signature"><span class="tsd-kind-property">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Dependencies</span></div>
|
|
246
|
+
<div class="tsd-comment tsd-typography"><p>Project dependencies.</p>
|
|
247
|
+
</div><aside class="tsd-sources">
|
|
248
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.deps</p></aside></section>
|
|
249
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
250
|
+
<h3 class="tsd-anchor-link" id="devcontainer"><code class="tsd-tag">Readonly</code><span>dev<wbr/>Container</span><a href="#devcontainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
251
|
+
<div class="tsd-signature"><span class="tsd-kind-property">devContainer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DevContainer</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div>
|
|
252
|
+
<div class="tsd-comment tsd-typography"><p>Access for .devcontainer.json (used for GitHub Codespaces)</p>
|
|
134
253
|
<p>This will be <code>undefined</code> if devContainer boolean is false</p>
|
|
135
|
-
</div><aside class="tsd-sources"
|
|
136
|
-
|
|
254
|
+
</div><aside class="tsd-sources">
|
|
255
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.devContainer</p></aside></section>
|
|
256
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
257
|
+
<h3 class="tsd-anchor-link" id="docgen"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>docgen</span><a href="#docgen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
258
|
+
<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><aside class="tsd-sources">
|
|
259
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docgen</p></aside></section>
|
|
260
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
261
|
+
<h3 class="tsd-anchor-link" id="docsdirectory"><code class="tsd-tag">Readonly</code><span>docs<wbr/>Directory</span><a href="#docsdirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
262
|
+
<div class="tsd-signature"><span class="tsd-kind-property">docsDirectory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
263
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docsDirectory</p></aside></section>
|
|
264
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
265
|
+
<h3 class="tsd-anchor-link" id="eslint"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>eslint</span><a href="#eslint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
266
|
+
<div class="tsd-signature"><span class="tsd-kind-property">eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Eslint</span></div><aside class="tsd-sources">
|
|
267
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.eslint</p></aside></section>
|
|
268
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
269
|
+
<h3 class="tsd-anchor-link" id="gitattributes"><code class="tsd-tag">Readonly</code><span>gitattributes</span><a href="#gitattributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
270
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitattributes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">GitAttributesFile</span></div>
|
|
271
|
+
<div class="tsd-comment tsd-typography"><p>The .gitattributes file for this repository.</p>
|
|
272
|
+
</div><aside class="tsd-sources">
|
|
273
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitattributes</p></aside></section>
|
|
274
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
275
|
+
<h3 class="tsd-anchor-link" id="github"><code class="tsd-tag">Readonly</code><span>github</span><a href="#github" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
276
|
+
<div class="tsd-signature"><span class="tsd-kind-property">github</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">GitHub</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div>
|
|
277
|
+
<div class="tsd-comment tsd-typography"><p>Access all github components.</p>
|
|
137
278
|
<p>This will be <code>undefined</code> for subprojects.</p>
|
|
138
|
-
</div><aside class="tsd-sources"
|
|
139
|
-
|
|
279
|
+
</div><aside class="tsd-sources">
|
|
280
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.github</p></aside></section>
|
|
281
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
282
|
+
<h3 class="tsd-anchor-link" id="gitignore"><code class="tsd-tag">Readonly</code><span>gitignore</span><a href="#gitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
283
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitignore</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IgnoreFile</span></div>
|
|
284
|
+
<div class="tsd-comment tsd-typography"><p>.gitignore</p>
|
|
285
|
+
</div><aside class="tsd-sources">
|
|
286
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitignore</p></aside></section>
|
|
287
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
288
|
+
<h3 class="tsd-anchor-link" id="gitpod"><code class="tsd-tag">Readonly</code><span>gitpod</span><a href="#gitpod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
289
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitpod</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Gitpod</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div>
|
|
290
|
+
<div class="tsd-comment tsd-typography"><p>Access for Gitpod</p>
|
|
140
291
|
<p>This will be <code>undefined</code> if gitpod boolean is false</p>
|
|
141
|
-
</div><aside class="tsd-sources"
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
</div><aside class="tsd-sources"
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
</div><aside class="tsd-sources"
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
</div><aside class="tsd-sources"
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
292
|
+
</div><aside class="tsd-sources">
|
|
293
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitpod</p></aside></section>
|
|
294
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
295
|
+
<h3 class="tsd-anchor-link" id="jest"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>jest</span><a href="#jest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
296
|
+
<div class="tsd-signature"><span class="tsd-kind-property">jest</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Jest</span></div>
|
|
297
|
+
<div class="tsd-comment tsd-typography"><p>The Jest configuration (if enabled)</p>
|
|
298
|
+
</div><aside class="tsd-sources">
|
|
299
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.jest</p></aside></section>
|
|
300
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
301
|
+
<h3 class="tsd-anchor-link" id="libdir"><code class="tsd-tag">Readonly</code><span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
302
|
+
<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>
|
|
303
|
+
<div class="tsd-comment tsd-typography"><p>The directory in which compiled .js files reside.</p>
|
|
304
|
+
</div><aside class="tsd-sources">
|
|
305
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.libdir</p></aside></section>
|
|
306
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
307
|
+
<h3 class="tsd-anchor-link" id="logger"><code class="tsd-tag">Readonly</code><span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
308
|
+
<div class="tsd-signature"><span class="tsd-kind-property">logger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div>
|
|
309
|
+
<div class="tsd-comment tsd-typography"><p>Logging utilities.</p>
|
|
310
|
+
</div><aside class="tsd-sources">
|
|
311
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.logger</p></aside></section>
|
|
312
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
313
|
+
<h3 class="tsd-anchor-link" id="name"><code class="tsd-tag">Readonly</code><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
314
|
+
<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>
|
|
315
|
+
<div class="tsd-comment tsd-typography"><p>Project name.</p>
|
|
316
|
+
</div><aside class="tsd-sources">
|
|
317
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.name</p></aside></section>
|
|
318
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
319
|
+
<h3 class="tsd-anchor-link" id="node"><code class="tsd-tag">Readonly</code><span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
320
|
+
<div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div>
|
|
321
|
+
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
322
|
+
</div><aside class="tsd-sources">
|
|
323
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.node</p></aside></section>
|
|
324
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
325
|
+
<h3 class="tsd-anchor-link" id="nodeversion"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>node<wbr/>Version</span><a href="#nodeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
326
|
+
<div class="tsd-signature"><span class="tsd-kind-property">nodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
327
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.nodeVersion</p></aside></section>
|
|
328
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
329
|
+
<h3 class="tsd-anchor-link" id="npmignore"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npmignore</span><a href="#npmignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
330
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npmignore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFile</span></div>
|
|
331
|
+
<div class="tsd-comment tsd-typography"><p>The .npmignore file.</p>
|
|
332
|
+
</div><aside class="tsd-sources">
|
|
333
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmignore</p></aside></section>
|
|
334
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
335
|
+
<h3 class="tsd-anchor-link" id="outdir"><code class="tsd-tag">Readonly</code><span>outdir</span><a href="#outdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
336
|
+
<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>
|
|
337
|
+
<div class="tsd-comment tsd-typography"><p>Absolute output directory of this project.</p>
|
|
338
|
+
</div><aside class="tsd-sources">
|
|
339
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.outdir</p></aside></section>
|
|
340
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
341
|
+
<h3 class="tsd-anchor-link" id="package"><code class="tsd-tag">Readonly</code><span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
342
|
+
<div class="tsd-signature"><span class="tsd-kind-property">package</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NodePackage</span></div>
|
|
343
|
+
<div class="tsd-comment tsd-typography"><p>API for managing the node package.</p>
|
|
344
|
+
</div><aside class="tsd-sources">
|
|
345
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.package</p></aside></section>
|
|
346
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
347
|
+
<h3 class="tsd-anchor-link" id="parent"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
348
|
+
<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>
|
|
349
|
+
<div class="tsd-comment tsd-typography"><p>A parent project. If undefined, this is the root project.</p>
|
|
350
|
+
</div><aside class="tsd-sources">
|
|
351
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.parent</p></aside></section>
|
|
352
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
353
|
+
<h3 class="tsd-anchor-link" id="prettier"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>prettier</span><a href="#prettier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
354
|
+
<div class="tsd-signature"><span class="tsd-kind-property">prettier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Prettier</span></div><aside class="tsd-sources">
|
|
355
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.prettier</p></aside></section>
|
|
356
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
357
|
+
<h3 class="tsd-anchor-link" id="projectbuild"><code class="tsd-tag">Readonly</code><span>project<wbr/>Build</span><a href="#projectbuild" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
358
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projectBuild</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProjectBuild</span></div>
|
|
359
|
+
<div class="tsd-comment tsd-typography"><p>Manages the build process of the project.</p>
|
|
360
|
+
</div><aside class="tsd-sources">
|
|
361
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectBuild</p></aside></section>
|
|
362
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
363
|
+
<h3 class="tsd-anchor-link" id="release"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
364
|
+
<div class="tsd-signature"><span class="tsd-kind-property">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Release</span></div>
|
|
365
|
+
<div class="tsd-comment tsd-typography"><p>Release management.</p>
|
|
366
|
+
</div><aside class="tsd-sources">
|
|
367
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.release</p></aside></section>
|
|
368
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
369
|
+
<h3 class="tsd-anchor-link" id="runner"><code class="tsd-tag">Readonly</code><span>runner</span><a href="#runner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
370
|
+
<div class="tsd-signature"><span class="tsd-kind-property">runner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeScriptRunner</span></div>
|
|
371
|
+
<div class="tsd-comment tsd-typography"><p>The TypeScript runner used for executing TypeScript files.</p>
|
|
372
|
+
</div><aside class="tsd-sources">
|
|
373
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runner</p></aside></section>
|
|
374
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
375
|
+
<h3 class="tsd-anchor-link" id="runscriptcommand"><code class="tsd-tag">Readonly</code><span>run<wbr/>Script<wbr/>Command</span><a href="#runscriptcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
376
|
+
<div class="tsd-signature"><span class="tsd-kind-property">runScriptCommand</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
377
|
+
<div class="tsd-comment tsd-typography"><p>The command to use to run scripts (e.g. <code>yarn run</code> or <code>npm run</code> depends on the package manager).</p>
|
|
378
|
+
</div><aside class="tsd-sources">
|
|
379
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runScriptCommand</p></aside></section>
|
|
380
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
381
|
+
<h3 class="tsd-anchor-link" id="srcdir"><code class="tsd-tag">Readonly</code><span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
382
|
+
<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>
|
|
383
|
+
<div class="tsd-comment tsd-typography"><p>The directory in which the .ts sources reside.</p>
|
|
384
|
+
</div><aside class="tsd-sources">
|
|
385
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.srcdir</p></aside></section>
|
|
386
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
387
|
+
<h3 class="tsd-anchor-link" id="tasks"><code class="tsd-tag">Readonly</code><span>tasks</span><a href="#tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
388
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Tasks</span></div>
|
|
389
|
+
<div class="tsd-comment tsd-typography"><p>Project tasks.</p>
|
|
390
|
+
</div><aside class="tsd-sources">
|
|
391
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tasks</p></aside></section>
|
|
392
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
393
|
+
<h3 class="tsd-anchor-link" id="testdir"><code class="tsd-tag">Readonly</code><span>testdir</span><a href="#testdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
394
|
+
<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>
|
|
395
|
+
<div class="tsd-comment tsd-typography"><p>The directory in which tests reside.</p>
|
|
396
|
+
</div><aside class="tsd-sources">
|
|
397
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testdir</p></aside></section>
|
|
398
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
399
|
+
<h3 class="tsd-anchor-link" id="tsconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig</span><a href="#tsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
400
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfig</span></div><aside class="tsd-sources">
|
|
401
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfig</p></aside></section>
|
|
402
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
403
|
+
<h3 class="tsd-anchor-link" id="tsconfigdev"><code class="tsd-tag">Readonly</code><span>tsconfig<wbr/>Dev</span><a href="#tsconfigdev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
404
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tsconfigDev</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypescriptConfig</span></div>
|
|
405
|
+
<div class="tsd-comment tsd-typography"><p>A typescript configuration file which covers all files (sources, tests, projen).</p>
|
|
406
|
+
</div><aside class="tsd-sources">
|
|
407
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigDev</p></aside></section>
|
|
408
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
409
|
+
<h3 class="tsd-anchor-link" id="tsconfigeslint"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig<wbr/>Eslint</span><a href="#tsconfigeslint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
410
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tsconfigEslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfig</span></div><aside class="tsd-sources">
|
|
411
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigEslint</p></aside></section>
|
|
412
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
413
|
+
<h3 class="tsd-anchor-link" id="upgradeworkflow"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>upgrade<wbr/>Workflow</span><a href="#upgradeworkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
414
|
+
<div class="tsd-signature"><span class="tsd-kind-property">upgradeWorkflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependencies</span></div>
|
|
415
|
+
<div class="tsd-comment tsd-typography"><p>The upgrade workflow.</p>
|
|
416
|
+
</div><aside class="tsd-sources">
|
|
417
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.upgradeWorkflow</p></aside></section>
|
|
418
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
419
|
+
<h3 class="tsd-anchor-link" id="vscode"><code class="tsd-tag">Readonly</code><span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
420
|
+
<div class="tsd-signature"><span class="tsd-kind-property">vscode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VsCode</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div>
|
|
421
|
+
<div class="tsd-comment tsd-typography"><p>Access all VSCode components.</p>
|
|
165
422
|
<p>This will be <code>undefined</code> for subprojects.</p>
|
|
166
|
-
</div><aside class="tsd-sources"
|
|
167
|
-
|
|
423
|
+
</div><aside class="tsd-sources">
|
|
424
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.vscode</p></aside></section>
|
|
425
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
426
|
+
<h3 class="tsd-anchor-link" id="watchtask"><code class="tsd-tag">Readonly</code><span>watch<wbr/>Task</span><a href="#watchtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
427
|
+
<div class="tsd-signature"><span class="tsd-kind-property">watchTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
428
|
+
<div class="tsd-comment tsd-typography"><p>The "watch" task.</p>
|
|
429
|
+
</div><aside class="tsd-sources">
|
|
430
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.watchTask</p></aside></section>
|
|
431
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
432
|
+
<h3 class="tsd-anchor-link" id="workflowbootstrapsteps"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowbootstrapsteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
433
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflowBootstrapSteps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
434
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowBootstrapSteps</p></aside></section>
|
|
435
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
436
|
+
<h3 class="tsd-anchor-link" id="workflowpackagecache"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Package<wbr/>Cache</span><a href="#workflowpackagecache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
437
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflowPackageCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
438
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowPackageCache</p></aside></section>
|
|
439
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
440
|
+
<h3 class="tsd-anchor-link" id="default_task"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>DEFAULT_<wbr/>TASK</span><a href="#default_task" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
441
|
+
<div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_TASK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"default"</span></div>
|
|
442
|
+
<div class="tsd-comment tsd-typography"><p>The name of the default task (the task executed when <code>projen</code> is run without arguments). Normally
|
|
168
443
|
this task should synthesize the project files.</p>
|
|
169
|
-
</div><aside class="tsd-sources"
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
444
|
+
</div><aside class="tsd-sources">
|
|
445
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TASK</p></aside></section>
|
|
446
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
447
|
+
<h3 class="tsd-anchor-link" id="default_ts_jest_tranform_pattern"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span><a href="#default_ts_jest_tranform_pattern" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
448
|
+
<div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_TS_JEST_TRANFORM_PATTERN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^.+\\.[t]sx?$"</span></div><aside class="tsd-sources">
|
|
449
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TS_JEST_TRANFORM_PATTERN</p></aside></section></section></details>
|
|
450
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
451
|
+
<h2 class="tsd-anchor-link" id="accessors-1">Accessors<a href="#accessors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
452
|
+
<section>
|
|
453
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
454
|
+
<h3 class="tsd-anchor-link" id="buildtask"><span>build<wbr/>Task</span><a href="#buildtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
455
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
456
|
+
<li>
|
|
457
|
+
<div class="tsd-signature" id="buildtaskbuildtask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">buildTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
458
|
+
<div class="tsd-description">
|
|
459
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
460
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildTask</p></aside></div></li></ul></section>
|
|
461
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
462
|
+
<h3 class="tsd-anchor-link" id="buildworkflowjobid"><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span><a href="#buildworkflowjobid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
463
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
464
|
+
<li>
|
|
465
|
+
<div class="tsd-signature" id="buildworkflowjobidbuildworkflowjobid"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">buildWorkflowJobId</span><span class="tsd-signature-symbol">()</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">undefined</span></div>
|
|
466
|
+
<div class="tsd-description">
|
|
467
|
+
<div class="tsd-comment tsd-typography"><p>The job ID of the build workflow.</p>
|
|
468
|
+
</div>
|
|
469
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
|
|
470
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflowJobId</p></aside></div></li></ul></section>
|
|
471
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
472
|
+
<h3 class="tsd-anchor-link" id="cdkversion"><span>cdk<wbr/>Version</span><a href="#cdkversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
473
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
474
|
+
<li>
|
|
475
|
+
<div class="tsd-signature" id="cdkversioncdkversion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">cdkVersion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
476
|
+
<div class="tsd-description">
|
|
477
|
+
<div class="tsd-comment tsd-typography"><p>The CDK version this app is using.</p>
|
|
478
|
+
</div>
|
|
479
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
480
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkVersion</p></aside></div></li></ul></section>
|
|
481
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
482
|
+
<h3 class="tsd-anchor-link" id="compiletask"><span>compile<wbr/>Task</span><a href="#compiletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
483
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
484
|
+
<li>
|
|
485
|
+
<div class="tsd-signature" id="compiletaskcompiletask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">compileTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
486
|
+
<div class="tsd-description">
|
|
487
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
488
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.compileTask</p></aside></div></li></ul></section>
|
|
489
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
490
|
+
<h3 class="tsd-anchor-link" id="components"><span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
491
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
492
|
+
<li>
|
|
493
|
+
<div class="tsd-signature" id="componentscomponents"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">components</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">[]</span></div>
|
|
494
|
+
<div class="tsd-description">
|
|
495
|
+
<div class="tsd-comment tsd-typography"><p>Returns all the components within this project.</p>
|
|
496
|
+
</div>
|
|
497
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
498
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.components</p></aside></div></li></ul></section>
|
|
499
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
500
|
+
<h3 class="tsd-anchor-link" id="ejected"><span>ejected</span><a href="#ejected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
501
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
502
|
+
<li>
|
|
503
|
+
<div class="tsd-signature" id="ejectedejected"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">ejected</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
504
|
+
<div class="tsd-description">
|
|
505
|
+
<div class="tsd-comment tsd-typography"><p>Whether or not the project is being ejected.</p>
|
|
506
|
+
</div>
|
|
507
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
508
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.ejected</p></aside></div></li></ul></section>
|
|
509
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
510
|
+
<h3 class="tsd-anchor-link" id="files"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
511
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
512
|
+
<li>
|
|
513
|
+
<div class="tsd-signature" id="filesfiles"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">files</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FileBase</span><span class="tsd-signature-symbol">[]</span></div>
|
|
514
|
+
<div class="tsd-description">
|
|
515
|
+
<div class="tsd-comment tsd-typography"><p>All files in this project.</p>
|
|
516
|
+
</div>
|
|
517
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileBase</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
518
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.files</p></aside></div></li></ul></section>
|
|
519
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
520
|
+
<h3 class="tsd-anchor-link" id="initproject"><span>init<wbr/>Project</span><a href="#initproject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
521
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
522
|
+
<li>
|
|
523
|
+
<div class="tsd-signature" id="initprojectinitproject"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">initProject</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InitProject</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div>
|
|
524
|
+
<div class="tsd-description">
|
|
525
|
+
<div class="tsd-comment tsd-typography"><p>The options used when this project is bootstrapped via <code>projen new</code>. It
|
|
526
|
+
includes the original set of options passed to the CLI and also the JSII
|
|
527
|
+
FQN of the project type.</p>
|
|
528
|
+
</div>
|
|
529
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InitProject</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4>
|
|
530
|
+
<div class="tsd-comment tsd-typography">
|
|
531
|
+
<div class="tsd-tag-deprecated">
|
|
532
|
+
<h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use the <code>initProject</code> argument passed to <code>Component.projectCreation()</code> instead.</p>
|
|
533
|
+
</div></div><aside class="tsd-sources">
|
|
534
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.initProject</p></aside></div></li></ul></section>
|
|
535
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
536
|
+
<h3 class="tsd-anchor-link" id="maxnodeversion"><span>max<wbr/>Node<wbr/>Version</span><a href="#maxnodeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
537
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
538
|
+
<li>
|
|
539
|
+
<div class="tsd-signature" id="maxnodeversionmaxnodeversion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">maxNodeVersion</span><span class="tsd-signature-symbol">()</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">undefined</span></div>
|
|
540
|
+
<div class="tsd-description">
|
|
541
|
+
<div class="tsd-comment tsd-typography"><p>Maximum node version supported by this package.</p>
|
|
178
542
|
<p>The value indicates the package is incompatible with newer versions.</p>
|
|
179
|
-
</div
|
|
543
|
+
</div>
|
|
544
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
|
|
545
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.maxNodeVersion</p></aside></div></li></ul></section>
|
|
546
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
547
|
+
<h3 class="tsd-anchor-link" id="minnodeversion"><span>min<wbr/>Node<wbr/>Version</span><a href="#minnodeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
548
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
549
|
+
<li>
|
|
550
|
+
<div class="tsd-signature" id="minnodeversionminnodeversion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">minNodeVersion</span><span class="tsd-signature-symbol">()</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">undefined</span></div>
|
|
551
|
+
<div class="tsd-description">
|
|
552
|
+
<div class="tsd-comment tsd-typography"><p>The minimum node version required by this package to function.</p>
|
|
180
553
|
<p>This value indicates the package is incompatible with older versions.</p>
|
|
181
|
-
</div
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
554
|
+
</div>
|
|
555
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
|
|
556
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.minNodeVersion</p></aside></div></li></ul></section>
|
|
557
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
558
|
+
<h3 class="tsd-anchor-link" id="npmrc"><span>npmrc</span><a href="#npmrc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
559
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
560
|
+
<li>
|
|
561
|
+
<div class="tsd-signature" id="npmrcnpmrc"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">npmrc</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NpmConfig</span></div>
|
|
562
|
+
<div class="tsd-description">
|
|
563
|
+
<div class="tsd-comment tsd-typography"><p>The .npmrc file</p>
|
|
564
|
+
</div>
|
|
565
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">NpmConfig</span></h4><aside class="tsd-sources">
|
|
566
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmrc</p></aside></div></li></ul></section>
|
|
567
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
568
|
+
<h3 class="tsd-anchor-link" id="packagetask"><span>package<wbr/>Task</span><a href="#packagetask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
569
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
570
|
+
<li>
|
|
571
|
+
<div class="tsd-signature" id="packagetaskpackagetask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">packageTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
572
|
+
<div class="tsd-description">
|
|
573
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
574
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageTask</p></aside></div></li></ul></section>
|
|
575
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
576
|
+
<h3 class="tsd-anchor-link" id="postcompiletask"><span>post<wbr/>Compile<wbr/>Task</span><a href="#postcompiletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
577
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
578
|
+
<li>
|
|
579
|
+
<div class="tsd-signature" id="postcompiletaskpostcompiletask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">postCompileTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
580
|
+
<div class="tsd-description">
|
|
581
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
582
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postCompileTask</p></aside></div></li></ul></section>
|
|
583
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
584
|
+
<h3 class="tsd-anchor-link" id="precompiletask"><span>pre<wbr/>Compile<wbr/>Task</span><a href="#precompiletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
585
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
586
|
+
<li>
|
|
587
|
+
<div class="tsd-signature" id="precompiletaskprecompiletask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">preCompileTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
588
|
+
<div class="tsd-description">
|
|
589
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
590
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preCompileTask</p></aside></div></li></ul></section>
|
|
591
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
592
|
+
<h3 class="tsd-anchor-link" id="projencommand"><span>projen<wbr/>Command</span><a href="#projencommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
593
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
594
|
+
<li>
|
|
595
|
+
<div class="tsd-signature" id="projencommandprojencommand"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">projenCommand</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
596
|
+
<div class="tsd-description">
|
|
597
|
+
<div class="tsd-comment tsd-typography"><p>The command to use in order to run the projen CLI.</p>
|
|
598
|
+
</div>
|
|
599
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
600
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projenCommand</p></aside></div></li></ul></section>
|
|
601
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
602
|
+
<h3 class="tsd-anchor-link" id="root"><span>root</span><a href="#root" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
603
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
604
|
+
<li>
|
|
605
|
+
<div class="tsd-signature" id="rootroot"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">root</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span></div>
|
|
606
|
+
<div class="tsd-description">
|
|
607
|
+
<div class="tsd-comment tsd-typography"><p>The root project.</p>
|
|
608
|
+
</div>
|
|
609
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Project</span></h4><aside class="tsd-sources">
|
|
610
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.root</p></aside></div></li></ul></section>
|
|
611
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
612
|
+
<h3 class="tsd-anchor-link" id="subprojects"><span>subprojects</span><a href="#subprojects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
613
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
614
|
+
<li>
|
|
615
|
+
<div class="tsd-signature" id="subprojectssubprojects"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">subprojects</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">[]</span></div>
|
|
616
|
+
<div class="tsd-description">
|
|
617
|
+
<div class="tsd-comment tsd-typography"><p>Returns all the subprojects within this project.</p>
|
|
618
|
+
</div>
|
|
619
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
620
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.subprojects</p></aside></div></li></ul></section>
|
|
621
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
622
|
+
<h3 class="tsd-anchor-link" id="testtask"><span>test<wbr/>Task</span><a href="#testtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
623
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
624
|
+
<li>
|
|
625
|
+
<div class="tsd-signature" id="testtasktesttask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">testTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
|
|
626
|
+
<div class="tsd-description">
|
|
627
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
628
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testTask</p></aside></div></li></ul></section></section></details>
|
|
629
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
630
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
631
|
+
<section>
|
|
632
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
633
|
+
<h3 class="tsd-anchor-link" id="addbins"><span>add<wbr/>Bins</span><a href="#addbins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
634
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
635
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
636
|
+
<div class="tsd-signature tsd-anchor-link" id="addbins-1"><span class="tsd-kind-call-signature">addBins</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bins</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addbins-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
637
|
+
<div class="tsd-description">
|
|
638
|
+
<div class="tsd-parameters">
|
|
639
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
640
|
+
<ul class="tsd-parameter-list">
|
|
641
|
+
<li><span><span class="tsd-kind-parameter">bins</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></span></li></ul></div>
|
|
642
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
643
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBins</p></aside></div></li></ul></section>
|
|
644
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
645
|
+
<h3 class="tsd-anchor-link" id="addbundleddeps"><span>add<wbr/>Bundled<wbr/>Deps</span><a href="#addbundleddeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
646
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
647
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
648
|
+
<div class="tsd-signature tsd-anchor-link" id="addbundleddeps-1"><span class="tsd-kind-call-signature">addBundledDeps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addbundleddeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
649
|
+
<div class="tsd-description">
|
|
650
|
+
<div class="tsd-comment tsd-typography"><p>Defines bundled dependencies.</p>
|
|
188
651
|
<p>Bundled dependencies will be added as normal dependencies as well as to the
|
|
189
652
|
<code>bundledDependencies</code> section of your <code>package.json</code>.</p>
|
|
190
|
-
</div
|
|
653
|
+
</div>
|
|
654
|
+
<div class="tsd-parameters">
|
|
655
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
656
|
+
<ul class="tsd-parameter-list">
|
|
657
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
658
|
+
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
191
659
|
be installed in the next <code>pnpm projen</code> run and the version will be recorded
|
|
192
660
|
in your <code>package.json</code> file. You can upgrade manually or using <code>pnpm add/update</code>. If you wish to specify a version range use this syntax:
|
|
193
661
|
<code>module@^7</code>.</p>
|
|
194
|
-
</div></li></ul></div
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
662
|
+
</div></li></ul></div>
|
|
663
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
664
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBundledDeps</p></aside></div></li></ul></section>
|
|
665
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
666
|
+
<h3 class="tsd-anchor-link" id="adddeps"><span>add<wbr/>Deps</span><a href="#adddeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
667
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
668
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
669
|
+
<div class="tsd-signature tsd-anchor-link" id="adddeps-1"><span class="tsd-kind-call-signature">addDeps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#adddeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
670
|
+
<div class="tsd-description">
|
|
671
|
+
<div class="tsd-comment tsd-typography"><p>Defines normal dependencies.</p>
|
|
672
|
+
</div>
|
|
673
|
+
<div class="tsd-parameters">
|
|
674
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
675
|
+
<ul class="tsd-parameter-list">
|
|
676
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
677
|
+
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
200
678
|
be installed in the next <code>pnpm projen</code> run and the version will be recorded
|
|
201
679
|
in your <code>package.json</code> file. You can upgrade manually or using <code>pnpm add/update</code>. If you wish to specify a version range use this syntax:
|
|
202
680
|
<code>module@^7</code>.</p>
|
|
203
|
-
</div></li></ul></div
|
|
204
|
-
|
|
681
|
+
</div></li></ul></div>
|
|
682
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
683
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDeps</p></aside></div></li></ul></section>
|
|
684
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
685
|
+
<h3 class="tsd-anchor-link" id="adddevdeps"><span>add<wbr/>Dev<wbr/>Deps</span><a href="#adddevdeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
686
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
687
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
688
|
+
<div class="tsd-signature tsd-anchor-link" id="adddevdeps-1"><span class="tsd-kind-call-signature">addDevDeps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#adddevdeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
689
|
+
<div class="tsd-description">
|
|
690
|
+
<div class="tsd-comment tsd-typography"><p>Defines development/test dependencies.</p>
|
|
691
|
+
</div>
|
|
692
|
+
<div class="tsd-parameters">
|
|
693
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
694
|
+
<ul class="tsd-parameter-list">
|
|
695
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
696
|
+
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
205
697
|
be installed in the next <code>pnpm projen</code> run and the version will be recorded
|
|
206
698
|
in your <code>package.json</code> file. You can upgrade manually or using <code>pnpm add/update</code>. If you wish to specify a version range use this syntax:
|
|
207
699
|
<code>module@^7</code>.</p>
|
|
208
|
-
</div></li></ul></div
|
|
700
|
+
</div></li></ul></div>
|
|
701
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
702
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDevDeps</p></aside></div></li></ul></section>
|
|
703
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
704
|
+
<h3 class="tsd-anchor-link" id="addexcludefromcleanup"><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span><a href="#addexcludefromcleanup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
705
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
706
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
707
|
+
<div class="tsd-signature tsd-anchor-link" id="addexcludefromcleanup-1"><span class="tsd-kind-call-signature">addExcludeFromCleanup</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">globs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addexcludefromcleanup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
708
|
+
<div class="tsd-description">
|
|
709
|
+
<div class="tsd-comment tsd-typography"><p>Exclude the matching files from pre-synth cleanup. Can be used when, for example, some
|
|
209
710
|
source files include the projen marker and we don't want them to be erased during synth.</p>
|
|
210
|
-
</div
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
</div
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
711
|
+
</div>
|
|
712
|
+
<div class="tsd-parameters">
|
|
713
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
714
|
+
<ul class="tsd-parameter-list">
|
|
715
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">globs</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
716
|
+
<div class="tsd-comment tsd-typography"><p>The glob patterns to match</p>
|
|
717
|
+
</div></li></ul></div>
|
|
718
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
719
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addExcludeFromCleanup</p></aside></div></li></ul></section>
|
|
720
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
721
|
+
<h3 class="tsd-anchor-link" id="addfields"><span>add<wbr/>Fields</span><a href="#addfields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
722
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
723
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
724
|
+
<div class="tsd-signature tsd-anchor-link" id="addfields-1"><span class="tsd-kind-call-signature">addFields</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addfields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
725
|
+
<div class="tsd-description">
|
|
726
|
+
<div class="tsd-comment tsd-typography"><p>Directly set fields in <code>package.json</code>.</p>
|
|
727
|
+
</div>
|
|
728
|
+
<div class="tsd-parameters">
|
|
729
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
730
|
+
<ul class="tsd-parameter-list">
|
|
731
|
+
<li><span><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">any</span> <span class="tsd-signature-symbol">}</span></span>
|
|
732
|
+
<div class="tsd-comment tsd-typography"><p>The fields to set</p>
|
|
733
|
+
</div></li></ul></div>
|
|
734
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
735
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addFields</p></aside></div></li></ul></section>
|
|
736
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
737
|
+
<h3 class="tsd-anchor-link" id="addgitignore"><span>add<wbr/>Git<wbr/>Ignore</span><a href="#addgitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
738
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
739
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
740
|
+
<div class="tsd-signature tsd-anchor-link" id="addgitignore-1"><span class="tsd-kind-call-signature">addGitIgnore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addgitignore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
741
|
+
<div class="tsd-description">
|
|
742
|
+
<div class="tsd-comment tsd-typography"><p>Adds a .gitignore pattern.</p>
|
|
743
|
+
</div>
|
|
744
|
+
<div class="tsd-parameters">
|
|
745
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
746
|
+
<ul class="tsd-parameter-list">
|
|
747
|
+
<li><span><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></span>
|
|
748
|
+
<div class="tsd-comment tsd-typography"><p>The glob pattern to ignore.</p>
|
|
749
|
+
</div></li></ul></div>
|
|
750
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
751
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addGitIgnore</p></aside></div></li></ul></section>
|
|
752
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
753
|
+
<h3 class="tsd-anchor-link" id="addkeywords"><span>add<wbr/>Keywords</span><a href="#addkeywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
754
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
755
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
756
|
+
<div class="tsd-signature tsd-anchor-link" id="addkeywords-1"><span class="tsd-kind-call-signature">addKeywords</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">keywords</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addkeywords-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
757
|
+
<div class="tsd-description">
|
|
758
|
+
<div class="tsd-comment tsd-typography"><p>Adds keywords to package.json (deduplicated)</p>
|
|
759
|
+
</div>
|
|
760
|
+
<div class="tsd-parameters">
|
|
761
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
762
|
+
<ul class="tsd-parameter-list">
|
|
763
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">keywords</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
764
|
+
<div class="tsd-comment tsd-typography"><p>The keywords to add</p>
|
|
765
|
+
</div></li></ul></div>
|
|
766
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
767
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addKeywords</p></aside></div></li></ul></section>
|
|
768
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
769
|
+
<h3 class="tsd-anchor-link" id="addpackageignore"><span>add<wbr/>Package<wbr/>Ignore</span><a href="#addpackageignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
770
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
771
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
772
|
+
<div class="tsd-signature tsd-anchor-link" id="addpackageignore-1"><span class="tsd-kind-call-signature">addPackageIgnore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addpackageignore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
773
|
+
<div class="tsd-description">
|
|
774
|
+
<div class="tsd-comment tsd-typography"><p>Adds patterns to be ignored by npm.</p>
|
|
775
|
+
</div>
|
|
776
|
+
<div class="tsd-parameters">
|
|
777
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
778
|
+
<ul class="tsd-parameter-list">
|
|
779
|
+
<li><span><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></span>
|
|
780
|
+
<div class="tsd-comment tsd-typography"><p>The pattern to ignore.</p>
|
|
781
|
+
</div></li></ul></div>
|
|
782
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
783
|
+
<div class="tsd-comment tsd-typography">
|
|
784
|
+
<div class="tsd-tag-remarks">
|
|
785
|
+
<h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If you are having trouble getting an ignore to populate, try using your construct or component's preSynthesize method to properly delay calling this method.</p>
|
|
786
|
+
</div></div><aside class="tsd-sources">
|
|
787
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPackageIgnore</p></aside></div></li></ul></section>
|
|
788
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
789
|
+
<h3 class="tsd-anchor-link" id="addpeerdeps"><span>add<wbr/>Peer<wbr/>Deps</span><a href="#addpeerdeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
790
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
791
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
792
|
+
<div class="tsd-signature tsd-anchor-link" id="addpeerdeps-1"><span class="tsd-kind-call-signature">addPeerDeps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addpeerdeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
793
|
+
<div class="tsd-description">
|
|
794
|
+
<div class="tsd-comment tsd-typography"><p>Defines peer dependencies.</p>
|
|
221
795
|
<p>When adding peer dependencies, a devDependency will also be added on the
|
|
222
796
|
pinned version of the declared peer. This will ensure that you are testing
|
|
223
797
|
your code against the minimum version required from your consumers.</p>
|
|
224
|
-
</div
|
|
798
|
+
</div>
|
|
799
|
+
<div class="tsd-parameters">
|
|
800
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
801
|
+
<ul class="tsd-parameter-list">
|
|
802
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
803
|
+
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
225
804
|
be installed in the next <code>pnpm projen</code> run and the version will be recorded
|
|
226
805
|
in your <code>package.json</code> file. You can upgrade manually or using <code>pnpm add/update</code>. If you wish to specify a version range use this syntax:
|
|
227
806
|
<code>module@^7</code>.</p>
|
|
228
|
-
</div></li></ul></div
|
|
229
|
-
|
|
230
|
-
|
|
807
|
+
</div></li></ul></div>
|
|
808
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
809
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPeerDeps</p></aside></div></li></ul></section>
|
|
810
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
811
|
+
<h3 class="tsd-anchor-link" id="addscripts"><span>add<wbr/>Scripts</span><a href="#addscripts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
812
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
813
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
814
|
+
<div class="tsd-signature tsd-anchor-link" id="addscripts-1"><span class="tsd-kind-call-signature">addScripts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scripts</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addscripts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
815
|
+
<div class="tsd-description">
|
|
816
|
+
<div class="tsd-comment tsd-typography"><p>Replaces the contents of multiple npm package.json scripts.</p>
|
|
817
|
+
</div>
|
|
818
|
+
<div class="tsd-parameters">
|
|
819
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
820
|
+
<ul class="tsd-parameter-list">
|
|
821
|
+
<li><span><span class="tsd-kind-parameter">scripts</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span>
|
|
822
|
+
<div class="tsd-comment tsd-typography"><p>The scripts to set</p>
|
|
823
|
+
</div></li></ul></div>
|
|
824
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
825
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addScripts</p></aside></div></li></ul></section>
|
|
826
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
827
|
+
<h3 class="tsd-anchor-link" id="addtask"><span>add<wbr/>Task</span><a href="#addtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
828
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
829
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
830
|
+
<div class="tsd-signature tsd-anchor-link" id="addtask-1"><span class="tsd-kind-call-signature">addTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TaskOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span><a href="#addtask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
831
|
+
<div class="tsd-description">
|
|
832
|
+
<div class="tsd-comment tsd-typography"><p>Adds a new task to this project. This will fail if the project already has
|
|
231
833
|
a task with this name.</p>
|
|
232
|
-
</div
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
</div></li
|
|
239
|
-
<li
|
|
240
|
-
</
|
|
241
|
-
</div></
|
|
834
|
+
</div>
|
|
835
|
+
<div class="tsd-parameters">
|
|
836
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
837
|
+
<ul class="tsd-parameter-list">
|
|
838
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
|
|
839
|
+
<div class="tsd-comment tsd-typography"><p>The task name to add</p>
|
|
840
|
+
</div></li>
|
|
841
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">TaskOptions</span></span>
|
|
842
|
+
<div class="tsd-comment tsd-typography"><p>Task properties</p>
|
|
843
|
+
</div></li></ul></div>
|
|
844
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources">
|
|
845
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTask</p></aside></div></li></ul></section>
|
|
846
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
847
|
+
<h3 class="tsd-anchor-link" id="annotategenerated"><span>annotate<wbr/>Generated</span><a href="#annotategenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
848
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
849
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
850
|
+
<div class="tsd-signature tsd-anchor-link" id="annotategenerated-1"><span class="tsd-kind-call-signature">annotateGenerated</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">glob</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#annotategenerated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
851
|
+
<div class="tsd-description">
|
|
852
|
+
<div class="tsd-comment tsd-typography"><p>Marks the provided file(s) as being generated. This is achieved using the
|
|
242
853
|
github-linguist attributes. Generated files do not count against the
|
|
243
854
|
repository statistics and language breakdown.</p>
|
|
244
|
-
</div
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
</div></
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
</div
|
|
256
|
-
</div></li></ul></
|
|
257
|
-
<
|
|
855
|
+
</div>
|
|
856
|
+
<div class="tsd-parameters">
|
|
857
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
858
|
+
<ul class="tsd-parameter-list">
|
|
859
|
+
<li><span><span class="tsd-kind-parameter">glob</span>: <span class="tsd-signature-type">string</span></span>
|
|
860
|
+
<div class="tsd-comment tsd-typography"><p>the glob pattern to match (could be a file path).</p>
|
|
861
|
+
</div></li></ul></div>
|
|
862
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
863
|
+
<div class="tsd-comment tsd-typography">
|
|
864
|
+
<div class="tsd-tag-see">
|
|
865
|
+
<h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://github.com/github/linguist/blob/master/docs/overrides.md">https://github.com/github/linguist/blob/master/docs/overrides.md</a></p>
|
|
866
|
+
</div></div><aside class="tsd-sources">
|
|
867
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.annotateGenerated</p></aside></div></li></ul></section>
|
|
868
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
869
|
+
<h3 class="tsd-anchor-link" id="defaulttypescriptcompileroptions"><code class="tsd-tag">Protected</code><span>default<wbr/>Type<wbr/>Script<wbr/>Compiler<wbr/>Options</span><a href="#defaulttypescriptcompileroptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
870
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
871
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
872
|
+
<div class="tsd-signature tsd-anchor-link" id="defaulttypescriptcompileroptions-1"><span class="tsd-kind-call-signature">defaultTypeScriptCompilerOptions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypeScriptCompilerOptions</span><a href="#defaulttypescriptcompileroptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
873
|
+
<div class="tsd-description">
|
|
874
|
+
<div class="tsd-comment tsd-typography"><p>Projen default Typescript compiler options.</p>
|
|
875
|
+
</div>
|
|
876
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TypeScriptCompilerOptions</span></h4><aside class="tsd-sources">
|
|
877
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.defaultTypeScriptCompilerOptions</p></aside></div></li></ul></section>
|
|
878
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
879
|
+
<h3 class="tsd-anchor-link" id="postsynthesize"><span>post<wbr/>Synthesize</span><a href="#postsynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
880
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
881
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
882
|
+
<div class="tsd-signature tsd-anchor-link" id="postsynthesize-1"><span class="tsd-kind-call-signature">postSynthesize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#postsynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
883
|
+
<div class="tsd-description">
|
|
884
|
+
<div class="tsd-comment tsd-typography"><p>Called after all components are synthesized. Order is <em>not</em> guaranteed.</p>
|
|
885
|
+
</div>
|
|
886
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
887
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postSynthesize</p></aside></div></li></ul></section>
|
|
888
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
889
|
+
<h3 class="tsd-anchor-link" id="presynthesize"><span>pre<wbr/>Synthesize</span><a href="#presynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
890
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
891
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
892
|
+
<div class="tsd-signature tsd-anchor-link" id="presynthesize-1"><span class="tsd-kind-call-signature">preSynthesize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#presynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
893
|
+
<div class="tsd-description">
|
|
894
|
+
<div class="tsd-comment tsd-typography"><p>Called before all components are synthesized.</p>
|
|
895
|
+
</div>
|
|
896
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
897
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preSynthesize</p></aside></div></li></ul></section>
|
|
898
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
899
|
+
<h3 class="tsd-anchor-link" id="removescript"><span>remove<wbr/>Script</span><a href="#removescript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
900
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
901
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
902
|
+
<div class="tsd-signature tsd-anchor-link" id="removescript-1"><span class="tsd-kind-call-signature">removeScript</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removescript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
903
|
+
<div class="tsd-description">
|
|
904
|
+
<div class="tsd-comment tsd-typography"><p>Removes the npm script (always successful).</p>
|
|
905
|
+
</div>
|
|
906
|
+
<div class="tsd-parameters">
|
|
907
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
908
|
+
<ul class="tsd-parameter-list">
|
|
909
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
|
|
910
|
+
<div class="tsd-comment tsd-typography"><p>The name of the script.</p>
|
|
911
|
+
</div></li></ul></div>
|
|
912
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
913
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeScript</p></aside></div></li></ul></section>
|
|
914
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
915
|
+
<h3 class="tsd-anchor-link" id="removetask"><span>remove<wbr/>Task</span><a href="#removetask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
916
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
917
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
918
|
+
<div class="tsd-signature tsd-anchor-link" id="removetask-1"><span class="tsd-kind-call-signature">removeTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#removetask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
919
|
+
<div class="tsd-description">
|
|
920
|
+
<div class="tsd-comment tsd-typography"><p>Removes a task from a project.</p>
|
|
921
|
+
</div>
|
|
922
|
+
<div class="tsd-parameters">
|
|
923
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
924
|
+
<ul class="tsd-parameter-list">
|
|
925
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
|
|
926
|
+
<div class="tsd-comment tsd-typography"><p>The name of the task to remove.</p>
|
|
927
|
+
</div></li></ul></div>
|
|
928
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>The <code>Task</code> that was removed, otherwise <code>undefined</code>.</p>
|
|
929
|
+
<aside class="tsd-sources">
|
|
930
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeTask</p></aside></div></li></ul></section>
|
|
931
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
932
|
+
<h3 class="tsd-anchor-link" id="renderworkflowsetup"><span>render<wbr/>Workflow<wbr/>Setup</span><a href="#renderworkflowsetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
933
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
934
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
935
|
+
<div class="tsd-signature tsd-anchor-link" id="renderworkflowsetup-1"><span class="tsd-kind-call-signature">renderWorkflowSetup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenderWorkflowSetupOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><a href="#renderworkflowsetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
936
|
+
<div class="tsd-description">
|
|
937
|
+
<div class="tsd-comment tsd-typography"><p>Returns the set of workflow steps which should be executed to bootstrap a
|
|
258
938
|
workflow.</p>
|
|
259
|
-
</div
|
|
260
|
-
|
|
261
|
-
<
|
|
939
|
+
</div>
|
|
940
|
+
<div class="tsd-parameters">
|
|
941
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
942
|
+
<ul class="tsd-parameter-list">
|
|
943
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RenderWorkflowSetupOptions</span></span>
|
|
944
|
+
<div class="tsd-comment tsd-typography"><p>Options.</p>
|
|
945
|
+
</div></li></ul></div>
|
|
946
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></h4><p>Job steps</p>
|
|
947
|
+
<aside class="tsd-sources">
|
|
948
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.renderWorkflowSetup</p></aside></div></li></ul></section>
|
|
949
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
950
|
+
<h3 class="tsd-anchor-link" id="runtaskcommand"><span>run<wbr/>Task<wbr/>Command</span><a href="#runtaskcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
951
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
952
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
953
|
+
<div class="tsd-signature tsd-anchor-link" id="runtaskcommand-1"><span class="tsd-kind-call-signature">runTaskCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#runtaskcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
954
|
+
<div class="tsd-description">
|
|
955
|
+
<div class="tsd-comment tsd-typography"><p>Returns the shell command to execute in order to run a task. This will
|
|
262
956
|
typically be <code>pnpm projen TASK</code>.</p>
|
|
263
|
-
</div
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
957
|
+
</div>
|
|
958
|
+
<div class="tsd-parameters">
|
|
959
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
960
|
+
<ul class="tsd-parameter-list">
|
|
961
|
+
<li><span><span class="tsd-kind-parameter">task</span>: <span class="tsd-signature-type">Task</span></span>
|
|
962
|
+
<div class="tsd-comment tsd-typography"><p>The task for which the command is required</p>
|
|
963
|
+
</div></li></ul></div>
|
|
964
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
965
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runTaskCommand</p></aside></div></li></ul></section>
|
|
966
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
967
|
+
<h3 class="tsd-anchor-link" id="setscript"><span>set<wbr/>Script</span><a href="#setscript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
968
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
969
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
970
|
+
<div class="tsd-signature tsd-anchor-link" id="setscript-1"><span class="tsd-kind-call-signature">setScript</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setscript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
971
|
+
<div class="tsd-description">
|
|
972
|
+
<div class="tsd-comment tsd-typography"><p>Replaces the contents of an npm package.json script.</p>
|
|
973
|
+
</div>
|
|
974
|
+
<div class="tsd-parameters">
|
|
975
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
976
|
+
<ul class="tsd-parameter-list">
|
|
977
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
|
|
978
|
+
<div class="tsd-comment tsd-typography"><p>The script name</p>
|
|
979
|
+
</div></li>
|
|
980
|
+
<li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span>
|
|
981
|
+
<div class="tsd-comment tsd-typography"><p>The command to execute</p>
|
|
982
|
+
</div></li></ul></div>
|
|
983
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
984
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.setScript</p></aside></div></li></ul></section>
|
|
985
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
986
|
+
<h3 class="tsd-anchor-link" id="synth"><span>synth</span><a href="#synth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
987
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
988
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
989
|
+
<div class="tsd-signature tsd-anchor-link" id="synth-1"><span class="tsd-kind-call-signature">synth</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#synth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
990
|
+
<div class="tsd-description">
|
|
991
|
+
<div class="tsd-comment tsd-typography"><p>Synthesize all project files into <code>outdir</code>.</p>
|
|
268
992
|
<ol>
|
|
269
993
|
<li>Call "this.preSynthesize()"</li>
|
|
270
994
|
<li>Delete all generated files</li>
|
|
271
995
|
<li>Synthesize all subprojects</li>
|
|
272
996
|
<li>Synthesize all components of this project</li>
|
|
997
|
+
<li>Call "projectCreation()" for all components, only if the project is being created for the first time</li>
|
|
273
998
|
<li>Call "postSynthesize()" for all components of this project</li>
|
|
274
999
|
<li>Call "this.postSynthesize()"</li>
|
|
1000
|
+
<li>Call "postProjectCreation()" for all components, only if the project is being created for the first time</li>
|
|
275
1001
|
</ol>
|
|
276
|
-
</div
|
|
277
|
-
|
|
1002
|
+
</div>
|
|
1003
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
1004
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.synth</p></aside></div></li></ul></section>
|
|
1005
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1006
|
+
<h3 class="tsd-anchor-link" id="tostring"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1007
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1008
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1009
|
+
<div class="tsd-signature tsd-anchor-link" id="tostring-1"><span class="tsd-kind-call-signature">toString</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tostring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1010
|
+
<div class="tsd-description">
|
|
1011
|
+
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
1012
|
+
</div>
|
|
1013
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
1014
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.toString</p></aside></div></li></ul></section>
|
|
1015
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1016
|
+
<h3 class="tsd-anchor-link" id="tryfindfile"><span>try<wbr/>Find<wbr/>File</span><a href="#tryfindfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1017
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1018
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1019
|
+
<div class="tsd-signature tsd-anchor-link" id="tryfindfile-1"><span class="tsd-kind-call-signature">tryFindFile</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FileBase</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#tryfindfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1020
|
+
<div class="tsd-description">
|
|
1021
|
+
<div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and all
|
|
278
1022
|
its subprojects.</p>
|
|
279
|
-
</div
|
|
1023
|
+
</div>
|
|
1024
|
+
<div class="tsd-parameters">
|
|
1025
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1026
|
+
<ul class="tsd-parameter-list">
|
|
1027
|
+
<li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span>
|
|
1028
|
+
<div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be resolved
|
|
280
1029
|
from the root of <em>this</em> project.</p>
|
|
281
|
-
</div></li></ul></div
|
|
282
|
-
<
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
1030
|
+
</div></li></ul></div>
|
|
1031
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileBase</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>a <code>FileBase</code> or undefined if there is no file in that path</p>
|
|
1032
|
+
<aside class="tsd-sources">
|
|
1033
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindFile</p></aside></div></li></ul></section>
|
|
1034
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1035
|
+
<h3 class="tsd-anchor-link" id="tryfindobjectfile"><span>try<wbr/>Find<wbr/>Object<wbr/>File</span><a href="#tryfindobjectfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1036
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1037
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1038
|
+
<div class="tsd-signature tsd-anchor-link" id="tryfindobjectfile-1"><span class="tsd-kind-call-signature">tryFindObjectFile</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ObjectFile</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#tryfindobjectfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1039
|
+
<div class="tsd-description">
|
|
1040
|
+
<div class="tsd-comment tsd-typography"><p>Finds an object file (like JsonFile, YamlFile, etc.) by name.</p>
|
|
1041
|
+
</div>
|
|
1042
|
+
<div class="tsd-parameters">
|
|
1043
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1044
|
+
<ul class="tsd-parameter-list">
|
|
1045
|
+
<li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span>
|
|
1046
|
+
<div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
1047
|
+
</div></li></ul></div>
|
|
1048
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ObjectFile</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
|
|
1049
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindObjectFile</p></aside></div></li></ul></section>
|
|
1050
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1051
|
+
<h3 class="tsd-anchor-link" id="tryremovefile"><span>try<wbr/>Remove<wbr/>File</span><a href="#tryremovefile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1052
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1053
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1054
|
+
<div class="tsd-signature tsd-anchor-link" id="tryremovefile-1"><span class="tsd-kind-call-signature">tryRemoveFile</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FileBase</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#tryremovefile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1055
|
+
<div class="tsd-description">
|
|
1056
|
+
<div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and removes
|
|
288
1057
|
it.</p>
|
|
289
|
-
</div
|
|
1058
|
+
</div>
|
|
1059
|
+
<div class="tsd-parameters">
|
|
1060
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1061
|
+
<ul class="tsd-parameter-list">
|
|
1062
|
+
<li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span>
|
|
1063
|
+
<div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be
|
|
290
1064
|
resolved from the root of <em>this</em> project.</p>
|
|
291
|
-
</div></li></ul></div
|
|
1065
|
+
</div></li></ul></div>
|
|
1066
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileBase</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>a <code>FileBase</code> if the file was found and removed, or undefined if
|
|
292
1067
|
the file was not found.</p>
|
|
293
|
-
<aside class="tsd-sources"
|
|
1068
|
+
<aside class="tsd-sources">
|
|
1069
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></div></li></ul></section>
|
|
1070
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1071
|
+
<h3 class="tsd-anchor-link" id="with"><span>with</span><a href="#with" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1072
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1073
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1074
|
+
<div class="tsd-signature tsd-anchor-link" id="with-1"><span class="tsd-kind-call-signature">with</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">mixins</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IMixin</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConstruct</span><a href="#with-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1075
|
+
<div class="tsd-description">
|
|
1076
|
+
<div class="tsd-comment tsd-typography"><p>Applies one or more mixins to this construct.</p>
|
|
294
1077
|
<p>Mixins are applied in order. The list of constructs is captured at the
|
|
295
1078
|
start of the call, so constructs added by a mixin will not be visited.
|
|
296
1079
|
Use multiple <code>with()</code> calls if subsequent mixins should apply to added
|
|
297
1080
|
constructs.</p>
|
|
298
|
-
</div
|
|
299
|
-
|
|
300
|
-
<
|
|
1081
|
+
</div>
|
|
1082
|
+
<div class="tsd-parameters">
|
|
1083
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1084
|
+
<ul class="tsd-parameter-list">
|
|
1085
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">mixins</span>: <span class="tsd-signature-type">IMixin</span><span class="tsd-signature-symbol">[]</span></span>
|
|
1086
|
+
<div class="tsd-comment tsd-typography"><p>The mixins to apply</p>
|
|
1087
|
+
</div></li></ul></div>
|
|
1088
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IConstruct</span></h4><p>This construct for chaining</p>
|
|
1089
|
+
<aside class="tsd-sources">
|
|
1090
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.with</p></aside></div></li></ul></section>
|
|
1091
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1092
|
+
<h3 class="tsd-anchor-link" id="isconstruct"><code class="tsd-tag">Static</code><span>is<wbr/>Construct</span><a href="#isconstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1093
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1094
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1095
|
+
<div class="tsd-signature tsd-anchor-link" id="isconstruct-1"><span class="tsd-kind-call-signature">isConstruct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Construct</span><a href="#isconstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1096
|
+
<div class="tsd-description">
|
|
1097
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
301
1098
|
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
302
1099
|
instances, even when the construct library is symlinked.</p>
|
|
303
1100
|
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
@@ -310,10 +1107,75 @@ use a monorepo tool: in those cases, multiple copies of the <code>constructs</co
|
|
|
310
1107
|
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
311
1108
|
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
312
1109
|
this type-testing method instead.</p>
|
|
313
|
-
</div
|
|
314
|
-
|
|
315
|
-
<
|
|
316
|
-
|
|
1110
|
+
</div>
|
|
1111
|
+
<div class="tsd-parameters">
|
|
1112
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1113
|
+
<ul class="tsd-parameter-list">
|
|
1114
|
+
<li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span>
|
|
1115
|
+
<div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
1116
|
+
</div></li></ul></div>
|
|
1117
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
1118
|
+
<aside class="tsd-sources">
|
|
1119
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isConstruct</p></aside></div></li></ul></section>
|
|
1120
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1121
|
+
<h3 class="tsd-anchor-link" id="isproject"><code class="tsd-tag">Static</code><span>is<wbr/>Project</span><a href="#isproject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1122
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1123
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1124
|
+
<div class="tsd-signature tsd-anchor-link" id="isproject-1"><span class="tsd-kind-call-signature">isProject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Project</span><a href="#isproject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1125
|
+
<div class="tsd-description">
|
|
1126
|
+
<div class="tsd-comment tsd-typography"><p>Test whether the given construct is a project.</p>
|
|
1127
|
+
</div>
|
|
1128
|
+
<div class="tsd-parameters">
|
|
1129
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1130
|
+
<ul class="tsd-parameter-list">
|
|
1131
|
+
<li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span></li></ul></div>
|
|
1132
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Project</span></h4><aside class="tsd-sources">
|
|
1133
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isProject</p></aside></div></li></ul></section>
|
|
1134
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1135
|
+
<h3 class="tsd-anchor-link" id="of"><code class="tsd-tag">Static</code><span>of</span><a href="#of" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1136
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1137
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1138
|
+
<div class="tsd-signature tsd-anchor-link" id="of-1"><span class="tsd-kind-call-signature">of</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConstruct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><a href="#of-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1139
|
+
<div class="tsd-description">
|
|
1140
|
+
<div class="tsd-comment tsd-typography"><p>Find the closest ancestor project for given construct.
|
|
317
1141
|
When given a project, this it the project itself.</p>
|
|
318
|
-
</div
|
|
319
|
-
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.of</p></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#appentrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a><a href="#artifactsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a><a href="#artifactsjavascriptdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a><a href="#autoapprove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve</span></a><a href="#automerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#biome" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome</span></a><a href="#buildworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a><a href="#bundler" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler</span></a><a href="#cdkconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Config</span></a><a href="#cdkdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Deps</span></a><a href="#cdktasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Tasks</span></a><a href="#commitgenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a><a href="#defaulttask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Task</span></a><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a><a href="#devcontainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen</span></a><a href="#docsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint</span></a><a href="#gitattributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitattributes</span></a><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a><a href="#initproject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>init<wbr/>Project</span></a><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest</span></a><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a><a href="#logger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a><a href="#nodeversion" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node<wbr/>Version</span></a><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore</span></a><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier</span></a><a href="#projectbuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Build</span></a><a href="#projecttype" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Type</span></a><a href="#publisher" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publisher</span></a><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release</span></a><a href="#runscriptcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>Script<wbr/>Command</span></a><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a><a href="#tasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tasks</span></a><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig</span></a><a href="#tsconfigdev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a><a href="#tsconfigeslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Eslint</span></a><a href="#upgradeworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upgrade<wbr/>Workflow</span></a><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a><a href="#watchtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Task</span></a><a href="#workflowbootstrapsteps" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a><a href="#workflowpackagecache" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a><a href="#default_task" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TASK</span></a><a href="#default_ts_jest_tranform_pattern" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#allowlibrarydependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a><a href="#buildtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Task</span></a><a href="#buildworkflowjobid" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span></a><a href="#cdkversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a><a href="#compiletask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>compile<wbr/>Task</span></a><a href="#components" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>components</span></a><a href="#ejected" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ejected</span></a><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>entrypoint</span></a><a href="#files" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>files</span></a><a href="#manifest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>manifest</span></a><a href="#maxnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a><a href="#minnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a><a href="#npmrc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>npmrc</span></a><a href="#packagemanager" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Manager</span></a><a href="#packagetask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Task</span></a><a href="#postcompiletask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>post<wbr/>Compile<wbr/>Task</span></a><a href="#precompiletask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pre<wbr/>Compile<wbr/>Task</span></a><a href="#projencommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>projen<wbr/>Command</span></a><a href="#root" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root</span></a><a href="#subprojects" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subprojects</span></a><a href="#testtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>test<wbr/>Task</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addbins" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bins</span></a><a href="#addbundleddeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a><a href="#addcdkdependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cdk<wbr/>Dependency</span></a><a href="#addcompilecommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Compile<wbr/>Command</span></a><a href="#adddeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Deps</span></a><a href="#adddevdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a><a href="#addexcludefromcleanup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a><a href="#addfields" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Fields</span></a><a href="#addgitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Git<wbr/>Ignore</span></a><a href="#addkeywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Keywords</span></a><a href="#addpackageignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Package<wbr/>Ignore</span></a><a href="#addpeerdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a><a href="#addscripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a><a href="#addtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Task</span></a><a href="#addtestcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a><a href="#addtip" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tip</span></a><a href="#annotategenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a><a href="#defaulttypescriptcompileroptions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>default<wbr/>Type<wbr/>Script<wbr/>Compiler<wbr/>Options</span></a><a href="#hasscript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Script</span></a><a href="#postsynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a><a href="#presynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a><a href="#removescript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Script</span></a><a href="#removetask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Task</span></a><a href="#renderworkflowsetup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a><a href="#runtaskcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Task<wbr/>Command</span></a><a href="#setscript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Script</span></a><a href="#synth" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>synth</span></a><a href="#tostring" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#tryfindfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>File</span></a><a href="#tryfindjsonfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Json<wbr/>File</span></a><a href="#tryfindobjectfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Object<wbr/>File</span></a><a href="#tryremovefile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a><a href="#with" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a><a href="#isconstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a><a href="#isproject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Project</span></a><a href="#of" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>of</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1142
|
+
</div>
|
|
1143
|
+
<div class="tsd-parameters">
|
|
1144
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1145
|
+
<ul class="tsd-parameter-list">
|
|
1146
|
+
<li><span><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type">IConstruct</span></span></li></ul></div>
|
|
1147
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Project</span></h4>
|
|
1148
|
+
<div class="tsd-comment tsd-typography">
|
|
1149
|
+
<div class="tsd-tag-throws">
|
|
1150
|
+
<h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>when no project is found in the path to the root</p>
|
|
1151
|
+
</div></div><aside class="tsd-sources">
|
|
1152
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.of</p></aside></div></li></ul></section></section></details></div>
|
|
1153
|
+
<div class="col-sidebar">
|
|
1154
|
+
<div class="page-menu">
|
|
1155
|
+
<div class="tsd-navigation settings">
|
|
1156
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
1157
|
+
<h3>Settings</h3></summary>
|
|
1158
|
+
<div class="tsd-accordion-details">
|
|
1159
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
1160
|
+
<ul id="tsd-filter-options">
|
|
1161
|
+
<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>
|
|
1162
|
+
<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>
|
|
1163
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
1164
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1165
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
1166
|
+
<h3>On This Page</h3></summary>
|
|
1167
|
+
<div class="tsd-accordion-details">
|
|
1168
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
1169
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
1170
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
1171
|
+
<div><a href="#appentrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a><a href="#artifactsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a><a href="#artifactsjavascriptdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a><a href="#autoapprove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve</span></a><a href="#automerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#biome" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome</span></a><a href="#buildworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a><a href="#bundler" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler</span></a><a href="#cdkconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Config</span></a><a href="#cdkdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Deps</span></a><a href="#cdktasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Tasks</span></a><a href="#commitgenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a><a href="#defaulttask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Task</span></a><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a><a href="#devcontainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen</span></a><a href="#docsdirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint</span></a><a href="#gitattributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitattributes</span></a><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest</span></a><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a><a href="#logger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a><a href="#nodeversion" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node<wbr/>Version</span></a><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore</span></a><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier</span></a><a href="#projectbuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Build</span></a><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release</span></a><a href="#runner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runner</span></a><a href="#runscriptcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>Script<wbr/>Command</span></a><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a><a href="#tasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tasks</span></a><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig</span></a><a href="#tsconfigdev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a><a href="#tsconfigeslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Eslint</span></a><a href="#upgradeworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upgrade<wbr/>Workflow</span></a><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a><a href="#watchtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Task</span></a><a href="#workflowbootstrapsteps" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a><a href="#workflowpackagecache" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a><a href="#default_task" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TASK</span></a><a href="#default_ts_jest_tranform_pattern" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span></a></div></details>
|
|
1172
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary>
|
|
1173
|
+
<div><a href="#buildtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Task</span></a><a href="#buildworkflowjobid" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span></a><a href="#cdkversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a><a href="#compiletask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>compile<wbr/>Task</span></a><a href="#components" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>components</span></a><a href="#ejected" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ejected</span></a><a href="#files" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>files</span></a><a href="#initproject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>init<wbr/>Project</span></a><a href="#maxnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a><a href="#minnodeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a><a href="#npmrc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>npmrc</span></a><a href="#packagetask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Task</span></a><a href="#postcompiletask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>post<wbr/>Compile<wbr/>Task</span></a><a href="#precompiletask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pre<wbr/>Compile<wbr/>Task</span></a><a href="#projencommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>projen<wbr/>Command</span></a><a href="#root" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root</span></a><a href="#subprojects" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subprojects</span></a><a href="#testtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>test<wbr/>Task</span></a></div></details>
|
|
1174
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
1175
|
+
<div><a href="#addbins" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bins</span></a><a href="#addbundleddeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a><a href="#adddeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Deps</span></a><a href="#adddevdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a><a href="#addexcludefromcleanup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a><a href="#addfields" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Fields</span></a><a href="#addgitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Git<wbr/>Ignore</span></a><a href="#addkeywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Keywords</span></a><a href="#addpackageignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Package<wbr/>Ignore</span></a><a href="#addpeerdeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a><a href="#addscripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a><a href="#addtask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Task</span></a><a href="#annotategenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a><a href="#defaulttypescriptcompileroptions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>default<wbr/>Type<wbr/>Script<wbr/>Compiler<wbr/>Options</span></a><a href="#postsynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a><a href="#presynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a><a href="#removescript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Script</span></a><a href="#removetask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Task</span></a><a href="#renderworkflowsetup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a><a href="#runtaskcommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Task<wbr/>Command</span></a><a href="#setscript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Script</span></a><a href="#synth" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>synth</span></a><a href="#tostring" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#tryfindfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>File</span></a><a href="#tryfindobjectfile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Object<wbr/>File</span></a><a href="#tryremovefile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a><a href="#with" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a><a href="#isconstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a><a href="#isproject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Project</span></a><a href="#of" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>of</span></a></div></details></div></details></div>
|
|
1176
|
+
<div class="site-menu">
|
|
1177
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
1178
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
1179
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
1180
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
1181
|
+
<div class="overlay"></div></body></html>
|