cdk-serverless 2.14.6 → 2.15.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/docs/constructs/assets/hierarchy.js +1 -0
- package/docs/constructs/assets/icons.js +18 -0
- package/docs/constructs/assets/icons.svg +1 -0
- package/docs/constructs/assets/main.js +5 -3
- package/docs/constructs/assets/navigation.js +1 -0
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +1424 -1193
- package/docs/constructs/classes/AssetCdn.html +21 -187
- package/docs/constructs/classes/BaseApi.html +15 -177
- package/docs/constructs/classes/CognitoAuthentication.html +26 -223
- package/docs/constructs/classes/GraphQlApi.html +37 -516
- package/docs/constructs/classes/LambdaFunction.html +213 -1159
- package/docs/constructs/classes/RestApi.html +43 -397
- package/docs/constructs/classes/SingleTableDatastore.html +20 -174
- package/docs/constructs/classes/Workflow.html +24 -195
- package/docs/constructs/hierarchy.html +1 -0
- package/docs/constructs/index.html +34 -110
- package/docs/constructs/interfaces/AssetCdnProps.html +6 -99
- package/docs/constructs/interfaces/BaseApiProps.html +45 -202
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +40 -188
- package/docs/constructs/interfaces/GraphQlApiProps.html +46 -218
- package/docs/constructs/interfaces/ICognitoAuthentication.html +3 -91
- package/docs/constructs/interfaces/IJwtAuthentication.html +7 -103
- package/docs/constructs/interfaces/JsResolverOptions.html +11 -106
- package/docs/constructs/interfaces/LambdaFunctionProps.html +35 -202
- package/docs/constructs/interfaces/LambdaTracingOptions.html +6 -90
- package/docs/constructs/interfaces/RestApiProps.html +62 -261
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +12 -111
- package/docs/constructs/interfaces/SingleTableDesign.html +12 -121
- package/docs/constructs/interfaces/VtlResolverOptions.html +8 -103
- package/docs/constructs/interfaces/WorkflowProps.html +6 -109
- package/docs/constructs/modules.html +1 -93
- package/docs/constructs/types/LambdaOptions.html +1 -62
- package/docs/lambda/assets/hierarchy.js +1 -0
- package/docs/lambda/assets/icons.js +18 -0
- package/docs/lambda/assets/icons.svg +1 -0
- package/docs/lambda/assets/main.js +5 -3
- package/docs/lambda/assets/navigation.js +1 -0
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +1424 -1193
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +38 -309
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +37 -308
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +38 -309
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +37 -306
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +36 -299
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +34 -288
- package/docs/lambda/classes/auth.JwtAuthorizer.html +34 -282
- package/docs/lambda/classes/errors.BadRequestError.html +16 -181
- package/docs/lambda/classes/errors.ForbiddenError.html +16 -181
- package/docs/lambda/classes/errors.HttpError.html +17 -189
- package/docs/lambda/classes/errors.NotFoundError.html +16 -181
- package/docs/lambda/classes/errors.UnauthenticatedError.html +16 -181
- package/docs/lambda/functions/api.createAppSyncHandler.html +3 -80
- package/docs/lambda/functions/api.createHttpHandler.html +2 -78
- package/docs/lambda/functions/api.createOpenApiHandler.html +2 -78
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +2 -78
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +2 -76
- package/docs/lambda/hierarchy.html +1 -0
- package/docs/lambda/index.html +34 -90
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +6 -105
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +7 -105
- package/docs/lambda/interfaces/api.HttpResponseContext.html +5 -100
- package/docs/lambda/interfaces/api.Operation.html +3 -92
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +4 -106
- package/docs/lambda/modules/api.html +1 -82
- package/docs/lambda/modules/auth.html +1 -64
- package/docs/lambda/modules/errors.html +1 -60
- package/docs/lambda/modules.html +1 -47
- package/docs/lambda/types/api.APIGatewayv1Handler.html +2 -62
- package/docs/lambda/types/api.AppSyncHandler.html +2 -82
- package/docs/lambda/types/api.HttpHandler.html +2 -84
- package/docs/projen/assets/hierarchy.js +1 -0
- package/docs/projen/assets/icons.js +18 -0
- package/docs/projen/assets/icons.svg +1 -0
- package/docs/projen/assets/main.js +5 -3
- package/docs/projen/assets/navigation.js +1 -0
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +1424 -1193
- package/docs/projen/classes/Datastore.html +26 -246
- package/docs/projen/classes/GraphQlApi.html +25 -212
- package/docs/projen/classes/RestApi.html +49 -347
- package/docs/projen/classes/ServerlessProject.html +245 -1409
- package/docs/projen/classes/Workflow.html +39 -273
- package/docs/projen/index.html +34 -98
- package/docs/projen/interfaces/DatastoreOptions.html +3 -77
- package/docs/projen/interfaces/GraphQlApiOptions.html +3 -77
- package/docs/projen/interfaces/RestApiOptions.html +3 -77
- package/docs/projen/interfaces/ServerlessProjectOptions.html +822 -2053
- package/docs/projen/interfaces/WorkflowOptions.html +3 -77
- package/docs/projen/modules.html +1 -69
- package/docs/projen/variables/PACKAGE_NAME.html +1 -50
- package/lib/constructs/authentication.d.ts +13 -0
- package/lib/constructs/authentication.js +47 -13
- package/lib/constructs/base-api.js +1 -1
- package/lib/constructs/func.js +1 -1
- package/lib/constructs/graphql.js +21 -11
- package/lib/constructs/rest-api.js +18 -8
- package/lib/constructs/table.js +1 -1
- package/lib/constructs/workflow.js +18 -8
- package/lib/lambda/auth.js +1 -1
- package/lib/lambda/handler.d.ts +1 -1
- package/lib/lambda/handler.js +21 -11
- package/lib/lambda/index.js +18 -8
- package/lib/projen/core.js +18 -8
- package/lib/projen/datastore.js +18 -8
- package/lib/projen/graphql.js +21 -11
- package/lib/projen/lazy-sampledir.js +1 -1
- package/lib/projen/rest-api.js +18 -8
- package/lib/projen/workflow.js +18 -8
- package/lib/tests/integ-test-util.js +3 -3
- package/package.json +26 -25
|
@@ -1,1170 +1,266 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
2
|
-
<div class="tsd-toolbar-contents container">
|
|
3
|
-
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
-
<div class="field">
|
|
6
|
-
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
-
<ul class="results">
|
|
8
|
-
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
|
|
10
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
-
<div class="container container-main">
|
|
12
|
-
<div class="col-content">
|
|
13
|
-
<div class="tsd-page-title">
|
|
14
|
-
<ul class="tsd-breadcrumb">
|
|
15
|
-
<li><a href="../modules.html">cdk-serverless</a></li>
|
|
16
|
-
<li><a href="ServerlessProject.html">ServerlessProject</a></li></ul>
|
|
17
|
-
<h1>Class ServerlessProject</h1></div>
|
|
18
|
-
<section class="tsd-panel tsd-comment">
|
|
19
|
-
<div class="tsd-comment tsd-typography"><p>The ServerlessProject construct sets up an AWS CDK TypeScript project with serverless application dependencies and configurations.
|
|
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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="ServerlessProject.html">ServerlessProject</a></li></ul><h1>Class ServerlessProject</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The ServerlessProject construct sets up an AWS CDK TypeScript project with serverless application dependencies and configurations.
|
|
20
2
|
This construct extends the projen AwsCdkTypeScriptApp to include additional dependencies and development dependencies required
|
|
21
3
|
for serverless applications. It also enables TypeScript projen configuration (projenrcTs).</p>
|
|
22
|
-
</div>
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
</
|
|
26
|
-
</div></section>
|
|
27
|
-
<
|
|
28
|
-
<
|
|
29
|
-
<
|
|
30
|
-
<
|
|
31
|
-
<
|
|
32
|
-
<
|
|
33
|
-
<
|
|
34
|
-
<
|
|
35
|
-
<
|
|
36
|
-
<
|
|
37
|
-
<
|
|
38
|
-
<
|
|
39
|
-
<
|
|
40
|
-
<
|
|
41
|
-
</
|
|
42
|
-
<
|
|
43
|
-
<
|
|
44
|
-
<
|
|
45
|
-
<a href="ServerlessProject.html#
|
|
46
|
-
<a href="ServerlessProject.html#
|
|
47
|
-
<a href="ServerlessProject.html#
|
|
48
|
-
<a href="ServerlessProject.html#
|
|
49
|
-
<a href="ServerlessProject.html#
|
|
50
|
-
<a href="ServerlessProject.html#
|
|
51
|
-
<a href="ServerlessProject.html#
|
|
52
|
-
<a href="ServerlessProject.html#
|
|
53
|
-
<a href="ServerlessProject.html#
|
|
54
|
-
<a href="ServerlessProject.html#
|
|
55
|
-
<a href="ServerlessProject.html#
|
|
56
|
-
<a href="ServerlessProject.html#
|
|
57
|
-
<a href="ServerlessProject.html#
|
|
58
|
-
<a href="ServerlessProject.html#
|
|
59
|
-
<a href="ServerlessProject.html#
|
|
60
|
-
<a href="ServerlessProject.html#
|
|
61
|
-
<a href="ServerlessProject.html#
|
|
62
|
-
<a href="ServerlessProject.html#
|
|
63
|
-
<a href="ServerlessProject.html#
|
|
64
|
-
<a href="ServerlessProject.html#
|
|
65
|
-
<a href="ServerlessProject.html#
|
|
66
|
-
<a href="ServerlessProject.html#
|
|
67
|
-
<a href="ServerlessProject.html#
|
|
68
|
-
<a href="ServerlessProject.html#
|
|
69
|
-
<a href="ServerlessProject.html#
|
|
70
|
-
<a href="ServerlessProject.html#
|
|
71
|
-
<a href="ServerlessProject.html#
|
|
72
|
-
<a href="ServerlessProject.html#
|
|
73
|
-
<a href="ServerlessProject.html#
|
|
74
|
-
<a href="ServerlessProject.html#
|
|
75
|
-
<a href="ServerlessProject.html#
|
|
76
|
-
<a href="ServerlessProject.html#
|
|
77
|
-
|
|
78
|
-
<a href="ServerlessProject.html#
|
|
79
|
-
<a href="ServerlessProject.html#
|
|
80
|
-
<a href="ServerlessProject.html#
|
|
81
|
-
<a href="ServerlessProject.html#
|
|
82
|
-
<a href="ServerlessProject.html#
|
|
83
|
-
<a href="ServerlessProject.html#
|
|
84
|
-
<a href="ServerlessProject.html#
|
|
85
|
-
<a href="ServerlessProject.html#
|
|
86
|
-
<a href="ServerlessProject.html#
|
|
87
|
-
<a href="ServerlessProject.html#
|
|
88
|
-
<a href="ServerlessProject.html#
|
|
89
|
-
<a href="ServerlessProject.html#
|
|
90
|
-
<a href="ServerlessProject.html#
|
|
91
|
-
<a href="ServerlessProject.html#
|
|
92
|
-
<a href="ServerlessProject.html#
|
|
93
|
-
<a href="ServerlessProject.html#
|
|
94
|
-
<a href="ServerlessProject.html#
|
|
95
|
-
</
|
|
96
|
-
<
|
|
97
|
-
<
|
|
98
|
-
|
|
99
|
-
<a href="ServerlessProject.html#
|
|
100
|
-
<a href="ServerlessProject.html#
|
|
101
|
-
<a href="ServerlessProject.html#
|
|
102
|
-
<a href="ServerlessProject.html#
|
|
103
|
-
<a href="ServerlessProject.html#
|
|
104
|
-
<a href="ServerlessProject.html#
|
|
105
|
-
<a href="ServerlessProject.html#
|
|
106
|
-
<a href="ServerlessProject.html#
|
|
107
|
-
<a href="ServerlessProject.html#
|
|
108
|
-
<a href="ServerlessProject.html#
|
|
109
|
-
<a href="ServerlessProject.html#
|
|
110
|
-
<a href="ServerlessProject.html#
|
|
111
|
-
<a href="ServerlessProject.html#
|
|
112
|
-
<a href="ServerlessProject.html#
|
|
113
|
-
<a href="ServerlessProject.html#
|
|
114
|
-
<a href="ServerlessProject.html#
|
|
115
|
-
<a href="ServerlessProject.html#
|
|
116
|
-
<a href="ServerlessProject.html#
|
|
117
|
-
<a href="ServerlessProject.html#
|
|
118
|
-
<a href="ServerlessProject.html#
|
|
119
|
-
</
|
|
120
|
-
<
|
|
121
|
-
<
|
|
122
|
-
<
|
|
123
|
-
<a href="ServerlessProject.html#
|
|
124
|
-
<a href="ServerlessProject.html#
|
|
125
|
-
<a href="ServerlessProject.html#
|
|
126
|
-
<a href="ServerlessProject.html#
|
|
127
|
-
<a href="ServerlessProject.html#
|
|
128
|
-
<a href="ServerlessProject.html#
|
|
129
|
-
<a href="ServerlessProject.html#
|
|
130
|
-
<a href="ServerlessProject.html#
|
|
131
|
-
<a href="ServerlessProject.html#
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
<a href="ServerlessProject.html#
|
|
135
|
-
|
|
136
|
-
<a href="ServerlessProject.html#addTestCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a>
|
|
137
|
-
<a href="ServerlessProject.html#addTip" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Tip</span></a>
|
|
138
|
-
<a href="ServerlessProject.html#annotateGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a>
|
|
139
|
-
<a href="ServerlessProject.html#hasScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Script</span></a>
|
|
140
|
-
<a href="ServerlessProject.html#postSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a>
|
|
141
|
-
<a href="ServerlessProject.html#preSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a>
|
|
142
|
-
<a href="ServerlessProject.html#removeScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Script</span></a>
|
|
143
|
-
<a href="ServerlessProject.html#removeTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task</span></a>
|
|
144
|
-
<a href="ServerlessProject.html#renderWorkflowSetup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a>
|
|
145
|
-
<a href="ServerlessProject.html#runTaskCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Task<wbr/>Command</span></a>
|
|
146
|
-
<a href="ServerlessProject.html#setScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Script</span></a>
|
|
147
|
-
<a href="ServerlessProject.html#synth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synth</span></a>
|
|
148
|
-
<a href="ServerlessProject.html#toString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
149
|
-
<a href="ServerlessProject.html#tryFindFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>File</span></a>
|
|
150
|
-
<a href="ServerlessProject.html#tryFindJsonFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Json<wbr/>File</span></a>
|
|
151
|
-
<a href="ServerlessProject.html#tryFindObjectFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Object<wbr/>File</span></a>
|
|
152
|
-
<a href="ServerlessProject.html#tryRemoveFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a>
|
|
153
|
-
<a href="ServerlessProject.html#isConstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
|
154
|
-
<a href="ServerlessProject.html#isProject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Project</span></a>
|
|
155
|
-
<a href="ServerlessProject.html#of" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>of</span></a>
|
|
156
|
-
</div></section></div></details></section></section>
|
|
157
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
158
|
-
<h2>Constructors</h2>
|
|
159
|
-
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
160
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
161
|
-
<ul class="tsd-signatures">
|
|
162
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_ServerlessProject"><span class="tsd-kind-constructor-signature">new <wbr/>Serverless<wbr/>Project</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ServerlessProject.html" class="tsd-signature-type tsd-kind-class">ServerlessProject</a><a href="#constructor.new_ServerlessProject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
163
|
-
<li class="tsd-description">
|
|
164
|
-
<div class="tsd-comment tsd-typography"><p>Creates an instance of ServerlessProject.</p>
|
|
165
|
-
</div>
|
|
166
|
-
<div class="tsd-parameters">
|
|
167
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
168
|
-
<ul class="tsd-parameter-list">
|
|
169
|
-
<li>
|
|
170
|
-
<h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ServerlessProjectOptions.html" class="tsd-signature-type tsd-kind-interface">ServerlessProjectOptions</a></h5>
|
|
171
|
-
<div class="tsd-comment tsd-typography"><p>The options for configuring the ServerlessProject.</p>
|
|
172
|
-
</div></li></ul></div>
|
|
173
|
-
<h4 class="tsd-returns-title">Returns <a href="ServerlessProject.html" class="tsd-signature-type tsd-kind-class">ServerlessProject</a></h4>
|
|
174
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
175
|
-
<p>Overrides pj.awscdk.AwsCdkTypeScriptApp.constructor</p></aside></li></ul></section></section>
|
|
176
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
177
|
-
<h2>Properties</h2>
|
|
178
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appEntrypoint" class="tsd-anchor"></a>
|
|
179
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>app<wbr/>Entrypoint</span><a href="#appEntrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
180
|
-
<div class="tsd-signature"><span class="tsd-kind-property">app<wbr/>Entrypoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
181
|
-
<div class="tsd-comment tsd-typography"><p>The CDK app entrypoint</p>
|
|
182
|
-
</div>
|
|
183
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
184
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.appEntrypoint</p></aside></section>
|
|
185
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsDirectory" class="tsd-anchor"></a>
|
|
186
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Directory</span><a href="#artifactsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
187
|
-
<div class="tsd-signature"><span class="tsd-kind-property">artifacts<wbr/>Directory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
188
|
-
<div class="tsd-comment tsd-typography"><p>The build output directory. An npm tarball will be created under the <code>js</code>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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
|
+
</code><button type="button">Copy</button></pre>
|
|
6
|
+
|
|
7
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy" data-refl="183"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">AwsCdkTypeScriptApp</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ServerlessProject</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ServerlessProject.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
8
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ServerlessProject.html#appentrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a>
|
|
9
|
+
<a href="ServerlessProject.html#artifactsdirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a>
|
|
10
|
+
<a href="ServerlessProject.html#artifactsjavascriptdirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a>
|
|
11
|
+
<a href="ServerlessProject.html#autoapprove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve?</span></a>
|
|
12
|
+
<a href="ServerlessProject.html#automerge" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge?</span></a>
|
|
13
|
+
<a href="ServerlessProject.html#buildworkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow?</span></a>
|
|
14
|
+
<a href="ServerlessProject.html#bundler" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler</span></a>
|
|
15
|
+
<a href="ServerlessProject.html#cdkconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Config</span></a>
|
|
16
|
+
<a href="ServerlessProject.html#cdkdeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Deps</span></a>
|
|
17
|
+
<a href="ServerlessProject.html#cdktasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cdk<wbr/>Tasks</span></a>
|
|
18
|
+
<a href="ServerlessProject.html#commitgenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a>
|
|
19
|
+
<a href="ServerlessProject.html#defaulttask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Task?</span></a>
|
|
20
|
+
<a href="ServerlessProject.html#deps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a>
|
|
21
|
+
<a href="ServerlessProject.html#devcontainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a>
|
|
22
|
+
<a href="ServerlessProject.html#docgen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen?</span></a>
|
|
23
|
+
<a href="ServerlessProject.html#docsdirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a>
|
|
24
|
+
<a href="ServerlessProject.html#eslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eslint?</span></a>
|
|
25
|
+
<a href="ServerlessProject.html#gitattributes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitattributes</span></a>
|
|
26
|
+
<a href="ServerlessProject.html#github" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a>
|
|
27
|
+
<a href="ServerlessProject.html#gitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a>
|
|
28
|
+
<a href="ServerlessProject.html#gitpod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a>
|
|
29
|
+
<a href="ServerlessProject.html#initproject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>init<wbr/>Project?</span></a>
|
|
30
|
+
<a href="ServerlessProject.html#jest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jest?</span></a>
|
|
31
|
+
<a href="ServerlessProject.html#libdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a>
|
|
32
|
+
<a href="ServerlessProject.html#logger" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logger</span></a>
|
|
33
|
+
<a href="ServerlessProject.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
|
34
|
+
<a href="ServerlessProject.html#node" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a>
|
|
35
|
+
<a href="ServerlessProject.html#nodeversion" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node<wbr/>Version?</span></a>
|
|
36
|
+
<a href="ServerlessProject.html#npmignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore?</span></a>
|
|
37
|
+
<a href="ServerlessProject.html#outdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a>
|
|
38
|
+
<a href="ServerlessProject.html#package" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a>
|
|
39
|
+
<a href="ServerlessProject.html#parent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent?</span></a>
|
|
40
|
+
<a href="ServerlessProject.html#prettier" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prettier?</span></a>
|
|
41
|
+
<a href="ServerlessProject.html#projectbuild" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Build</span></a>
|
|
42
|
+
<a href="ServerlessProject.html#projecttype" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Type</span></a>
|
|
43
|
+
<a href="ServerlessProject.html#publisher" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publisher?</span></a>
|
|
44
|
+
<a href="ServerlessProject.html#release" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release?</span></a>
|
|
45
|
+
<a href="ServerlessProject.html#runscriptcommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>Script<wbr/>Command</span></a>
|
|
46
|
+
<a href="ServerlessProject.html#srcdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a>
|
|
47
|
+
<a href="ServerlessProject.html#tasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tasks</span></a>
|
|
48
|
+
<a href="ServerlessProject.html#testdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a>
|
|
49
|
+
<a href="ServerlessProject.html#tsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig?</span></a>
|
|
50
|
+
<a href="ServerlessProject.html#tsconfigdev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a>
|
|
51
|
+
<a href="ServerlessProject.html#tsconfigeslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Eslint?</span></a>
|
|
52
|
+
<a href="ServerlessProject.html#upgradeworkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upgrade<wbr/>Workflow?</span></a>
|
|
53
|
+
<a href="ServerlessProject.html#vscode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a>
|
|
54
|
+
<a href="ServerlessProject.html#watchtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch<wbr/>Task</span></a>
|
|
55
|
+
<a href="ServerlessProject.html#workflowbootstrapsteps" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a>
|
|
56
|
+
<a href="ServerlessProject.html#workflowpackagecache" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a>
|
|
57
|
+
<a href="ServerlessProject.html#default_task" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TASK</span></a>
|
|
58
|
+
<a href="ServerlessProject.html#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"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span></a>
|
|
59
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="ServerlessProject.html#allowlibrarydependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a>
|
|
60
|
+
<a href="ServerlessProject.html#buildtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Task</span></a>
|
|
61
|
+
<a href="ServerlessProject.html#buildworkflowjobid" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span></a>
|
|
62
|
+
<a href="ServerlessProject.html#cdkversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a>
|
|
63
|
+
<a href="ServerlessProject.html#compiletask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>compile<wbr/>Task</span></a>
|
|
64
|
+
<a href="ServerlessProject.html#components" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>components</span></a>
|
|
65
|
+
<a href="ServerlessProject.html#ejected" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ejected</span></a>
|
|
66
|
+
<a href="ServerlessProject.html#entrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>entrypoint</span></a>
|
|
67
|
+
<a href="ServerlessProject.html#files" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>files</span></a>
|
|
68
|
+
<a href="ServerlessProject.html#manifest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>manifest</span></a>
|
|
69
|
+
<a href="ServerlessProject.html#maxnodeversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a>
|
|
70
|
+
<a href="ServerlessProject.html#minnodeversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a>
|
|
71
|
+
<a href="ServerlessProject.html#npmrc" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>npmrc</span></a>
|
|
72
|
+
<a href="ServerlessProject.html#packagemanager" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Manager</span></a>
|
|
73
|
+
<a href="ServerlessProject.html#packagetask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>package<wbr/>Task</span></a>
|
|
74
|
+
<a href="ServerlessProject.html#postcompiletask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>post<wbr/>Compile<wbr/>Task</span></a>
|
|
75
|
+
<a href="ServerlessProject.html#precompiletask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pre<wbr/>Compile<wbr/>Task</span></a>
|
|
76
|
+
<a href="ServerlessProject.html#projencommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>projen<wbr/>Command</span></a>
|
|
77
|
+
<a href="ServerlessProject.html#root" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root</span></a>
|
|
78
|
+
<a href="ServerlessProject.html#subprojects" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subprojects</span></a>
|
|
79
|
+
<a href="ServerlessProject.html#testtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>test<wbr/>Task</span></a>
|
|
80
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ServerlessProject.html#addbins" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bins</span></a>
|
|
81
|
+
<a href="ServerlessProject.html#addbundleddeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a>
|
|
82
|
+
<a href="ServerlessProject.html#addcdkdependency" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cdk<wbr/>Dependency</span></a>
|
|
83
|
+
<a href="ServerlessProject.html#addcompilecommand" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Compile<wbr/>Command</span></a>
|
|
84
|
+
<a href="ServerlessProject.html#adddeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Deps</span></a>
|
|
85
|
+
<a href="ServerlessProject.html#adddevdeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a>
|
|
86
|
+
<a href="ServerlessProject.html#addexcludefromcleanup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a>
|
|
87
|
+
<a href="ServerlessProject.html#addfields" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Fields</span></a>
|
|
88
|
+
<a href="ServerlessProject.html#addgitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Git<wbr/>Ignore</span></a>
|
|
89
|
+
<a href="ServerlessProject.html#addkeywords" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Keywords</span></a>
|
|
90
|
+
<a href="ServerlessProject.html#addpackageignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Package<wbr/>Ignore</span></a>
|
|
91
|
+
<a href="ServerlessProject.html#addpeerdeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a>
|
|
92
|
+
<a href="ServerlessProject.html#addscripts" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a>
|
|
93
|
+
<a href="ServerlessProject.html#addtask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Task</span></a>
|
|
94
|
+
<a href="ServerlessProject.html#addtestcommand" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a>
|
|
95
|
+
<a href="ServerlessProject.html#addtip" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tip</span></a>
|
|
96
|
+
<a href="ServerlessProject.html#annotategenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a>
|
|
97
|
+
<a href="ServerlessProject.html#hasscript" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Script</span></a>
|
|
98
|
+
<a href="ServerlessProject.html#postsynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a>
|
|
99
|
+
<a href="ServerlessProject.html#presynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a>
|
|
100
|
+
<a href="ServerlessProject.html#removescript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Script</span></a>
|
|
101
|
+
<a href="ServerlessProject.html#removetask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Task</span></a>
|
|
102
|
+
<a href="ServerlessProject.html#renderworkflowsetup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a>
|
|
103
|
+
<a href="ServerlessProject.html#runtaskcommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>Task<wbr/>Command</span></a>
|
|
104
|
+
<a href="ServerlessProject.html#setscript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Script</span></a>
|
|
105
|
+
<a href="ServerlessProject.html#synth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>synth</span></a>
|
|
106
|
+
<a href="ServerlessProject.html#tostring" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
107
|
+
<a href="ServerlessProject.html#tryfindfile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>File</span></a>
|
|
108
|
+
<a href="ServerlessProject.html#tryfindjsonfile" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Json<wbr/>File</span></a>
|
|
109
|
+
<a href="ServerlessProject.html#tryfindobjectfile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Object<wbr/>File</span></a>
|
|
110
|
+
<a href="ServerlessProject.html#tryremovefile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a>
|
|
111
|
+
<a href="ServerlessProject.html#isconstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
|
112
|
+
<a href="ServerlessProject.html#isproject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Project</span></a>
|
|
113
|
+
<a href="ServerlessProject.html#of" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>of</span></a>
|
|
114
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorserverlessproject" class="tsd-anchor"></a><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="ServerlessProject.html" 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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an instance of ServerlessProject.</p>
|
|
115
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ServerlessProjectOptions.html" class="tsd-signature-type tsd-kind-interface">ServerlessProjectOptions</a></span><div class="tsd-comment tsd-typography"><p>The options for configuring the ServerlessProject.</p>
|
|
116
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ServerlessProject.html" class="tsd-signature-type tsd-kind-class">ServerlessProject</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides pj.awscdk.AwsCdkTypeScriptApp.constructor</p></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appentrypoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">appEntrypoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CDK app entrypoint</p>
|
|
117
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.appEntrypoint</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsdirectory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">artifactsDirectory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The build output directory. An npm tarball will be created under the <code>js</code>
|
|
189
118
|
subdirectory. For example, if this is set to <code>dist</code> (the default), the npm
|
|
190
119
|
tarball will be placed under <code>dist/js/boom-boom-1.2.3.tg</code>.</p>
|
|
191
|
-
</div>
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
<div class="tsd-signature"><span class="tsd-kind-property">
|
|
197
|
-
|
|
198
|
-
</div>
|
|
199
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
200
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsJavascriptDirectory</p></aside></section>
|
|
201
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApprove" class="tsd-anchor"></a>
|
|
202
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Approve</span><a href="#autoApprove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
203
|
-
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Approve</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoApprove</span></div>
|
|
204
|
-
<div class="tsd-comment tsd-typography"><p>Auto approve set up for this project.</p>
|
|
205
|
-
</div>
|
|
206
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
207
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoApprove</p></aside></section>
|
|
208
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMerge" class="tsd-anchor"></a>
|
|
209
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Merge</span><a href="#autoMerge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
210
|
-
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Merge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoMerge</span></div>
|
|
211
|
-
<div class="tsd-comment tsd-typography"><p>Component that sets up mergify for merging approved pull requests.</p>
|
|
212
|
-
</div>
|
|
213
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
214
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoMerge</p></aside></section>
|
|
215
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflow" class="tsd-anchor"></a>
|
|
216
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Workflow</span><a href="#buildWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
217
|
-
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">BuildWorkflow</span></div>
|
|
218
|
-
<div class="tsd-comment tsd-typography"><p>The PR build GitHub workflow. <code>undefined</code> if <code>buildWorkflow</code> is disabled.</p>
|
|
219
|
-
</div>
|
|
220
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
221
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflow</p></aside></section>
|
|
222
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundler" class="tsd-anchor"></a>
|
|
223
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundler</span><a href="#bundler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
224
|
-
<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">
|
|
225
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.bundler</p></aside></section>
|
|
226
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkConfig" class="tsd-anchor"></a>
|
|
227
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Config</span><a href="#cdkConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
228
|
-
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">CdkConfig</span></div>
|
|
229
|
-
<div class="tsd-comment tsd-typography"><p>cdk.json configuration.</p>
|
|
230
|
-
</div>
|
|
231
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
232
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkConfig</p></aside></section>
|
|
233
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDeps" class="tsd-anchor"></a>
|
|
234
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Deps</span><a href="#cdkDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
235
|
-
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">AwsCdkDeps</span></div><aside class="tsd-sources">
|
|
236
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkDeps</p></aside></section>
|
|
237
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkTasks" class="tsd-anchor"></a>
|
|
238
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Tasks</span><a href="#cdkTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
239
|
-
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">CdkTasks</span></div>
|
|
240
|
-
<div class="tsd-comment tsd-typography"><p>Common CDK tasks.</p>
|
|
241
|
-
</div>
|
|
242
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
243
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkTasks</p></aside></section>
|
|
244
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitGenerated" class="tsd-anchor"></a>
|
|
245
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>commit<wbr/>Generated</span><a href="#commitGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
246
|
-
<div class="tsd-signature"><span class="tsd-kind-property">commit<wbr/>Generated</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
247
|
-
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
248
|
-
</div>
|
|
249
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
250
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.commitGenerated</p></aside></section>
|
|
251
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultTask" class="tsd-anchor"></a>
|
|
252
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>default<wbr/>Task</span><a href="#defaultTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
253
|
-
<div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Task</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Task</span></div>
|
|
254
|
-
<div class="tsd-comment tsd-typography"><p>This is the "default" task, the one that executes "projen". Undefined if
|
|
120
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsDirectory</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsjavascriptdirectory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>The location of the npm tarball after build (<code>${artifactsDirectory}/js</code>).</p>
|
|
121
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsJavascriptDirectory</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoapprove" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>Auto approve set up for this project.</p>
|
|
122
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoApprove</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="automerge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">autoMerge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMerge</span></div><div class="tsd-comment tsd-typography"><p>Component that sets up mergify for merging approved pull requests.</p>
|
|
123
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoMerge</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildworkflow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">buildWorkflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflow</span></div><div class="tsd-comment tsd-typography"><p>The PR build GitHub workflow. <code>undefined</code> if <code>buildWorkflow</code> is disabled.</p>
|
|
124
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflow</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundler" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.bundler</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>cdk.json configuration.</p>
|
|
125
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkConfig</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkdeps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkDeps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdktasks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>Common CDK tasks.</p>
|
|
126
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkTasks</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitgenerated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">commitGenerated</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
127
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.commitGenerated</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaulttask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>This is the "default" task, the one that executes "projen". Undefined if
|
|
255
128
|
the project is being ejected.</p>
|
|
256
|
-
</div>
|
|
257
|
-
|
|
258
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.defaultTask</p></aside></section>
|
|
259
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a>
|
|
260
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps</span><a href="#deps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
261
|
-
<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>
|
|
262
|
-
<div class="tsd-comment tsd-typography"><p>Project dependencies.</p>
|
|
263
|
-
</div>
|
|
264
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
265
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.deps</p></aside></section>
|
|
266
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devContainer" class="tsd-anchor"></a>
|
|
267
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Container</span><a href="#devContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
268
|
-
<div class="tsd-signature"><span class="tsd-kind-property">dev<wbr/>Container</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">DevContainer</span></div>
|
|
269
|
-
<div class="tsd-comment tsd-typography"><p>Access for .devcontainer.json (used for GitHub Codespaces)</p>
|
|
129
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.defaultTask</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Dependencies</span></div><div class="tsd-comment tsd-typography"><p>Project dependencies.</p>
|
|
130
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.deps</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devcontainer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">devContainer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DevContainer</span></div><div class="tsd-comment tsd-typography"><p>Access for .devcontainer.json (used for GitHub Codespaces)</p>
|
|
270
131
|
<p>This will be <code>undefined</code> if devContainer boolean is false</p>
|
|
271
|
-
</div>
|
|
272
|
-
|
|
273
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.devContainer</p></aside></section>
|
|
274
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a>
|
|
275
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docgen</span><a href="#docgen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
276
|
-
<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">
|
|
277
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docgen</p></aside></section>
|
|
278
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsDirectory" class="tsd-anchor"></a>
|
|
279
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docs<wbr/>Directory</span><a href="#docsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
280
|
-
<div class="tsd-signature"><span class="tsd-kind-property">docs<wbr/>Directory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
281
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docsDirectory</p></aside></section>
|
|
282
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a>
|
|
283
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint</span><a href="#eslint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
284
|
-
<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">
|
|
285
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.eslint</p></aside></section>
|
|
286
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitattributes" class="tsd-anchor"></a>
|
|
287
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitattributes</span><a href="#gitattributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
288
|
-
<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>
|
|
289
|
-
<div class="tsd-comment tsd-typography"><p>The .gitattributes file for this repository.</p>
|
|
290
|
-
</div>
|
|
291
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
292
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitattributes</p></aside></section>
|
|
293
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="github" class="tsd-anchor"></a>
|
|
294
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github</span><a href="#github" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
295
|
-
<div class="tsd-signature"><span class="tsd-kind-property">github</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">GitHub</span></div>
|
|
296
|
-
<div class="tsd-comment tsd-typography"><p>Access all github components.</p>
|
|
132
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.devContainer</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">docgen</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docgen</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsdirectory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">docsDirectory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docsDirectory</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Eslint</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.eslint</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitattributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>The .gitattributes file for this repository.</p>
|
|
133
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitattributes</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="github" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">github</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">GitHub</span></div><div class="tsd-comment tsd-typography"><p>Access all github components.</p>
|
|
297
134
|
<p>This will be <code>undefined</code> for subprojects.</p>
|
|
298
|
-
</div>
|
|
299
|
-
|
|
300
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.github</p></aside></section>
|
|
301
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a>
|
|
302
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitignore</span><a href="#gitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
303
|
-
<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>
|
|
304
|
-
<div class="tsd-comment tsd-typography"><p>.gitignore</p>
|
|
305
|
-
</div>
|
|
306
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
307
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitignore</p></aside></section>
|
|
308
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitpod" class="tsd-anchor"></a>
|
|
309
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitpod</span><a href="#gitpod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
310
|
-
<div class="tsd-signature"><span class="tsd-kind-property">gitpod</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Gitpod</span></div>
|
|
311
|
-
<div class="tsd-comment tsd-typography"><p>Access for Gitpod</p>
|
|
135
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.github</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">gitignore</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IgnoreFile</span></div><div class="tsd-comment tsd-typography"><p>.gitignore</p>
|
|
136
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitignore</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitpod" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">gitpod</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Gitpod</span></div><div class="tsd-comment tsd-typography"><p>Access for Gitpod</p>
|
|
312
137
|
<p>This will be <code>undefined</code> if gitpod boolean is false</p>
|
|
313
|
-
</div>
|
|
314
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
315
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitpod</p></aside></section>
|
|
316
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="initProject" class="tsd-anchor"></a>
|
|
317
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>init<wbr/>Project</span><a href="#initProject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
318
|
-
<div class="tsd-signature"><span class="tsd-kind-property">init<wbr/>Project</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">InitProject</span></div>
|
|
319
|
-
<div class="tsd-comment tsd-typography"><p>The options used when this project is bootstrapped via <code>projen new</code>. It
|
|
138
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitpod</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="initproject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>init<wbr/>Project</span><a href="#initproject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initProject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">InitProject</span></div><div class="tsd-comment tsd-typography"><p>The options used when this project is bootstrapped via <code>projen new</code>. It
|
|
320
139
|
includes the original set of options passed to the CLI and also the JSII
|
|
321
140
|
FQN of the project type.</p>
|
|
322
|
-
</div>
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
<div class="tsd-signature"><span class="tsd-kind-property">
|
|
328
|
-
|
|
329
|
-
</div>
|
|
330
|
-
|
|
331
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.
|
|
332
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="
|
|
333
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
334
|
-
<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>
|
|
335
|
-
<div class="tsd-comment tsd-typography"><p>The directory in which compiled .js files reside.</p>
|
|
336
|
-
</div>
|
|
337
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
338
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.libdir</p></aside></section>
|
|
339
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logger" class="tsd-anchor"></a>
|
|
340
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
341
|
-
<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>
|
|
342
|
-
<div class="tsd-comment tsd-typography"><p>Logging utilities.</p>
|
|
343
|
-
</div>
|
|
344
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
345
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.logger</p></aside></section>
|
|
346
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
|
|
347
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
348
|
-
<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>
|
|
349
|
-
<div class="tsd-comment tsd-typography"><p>Project name.</p>
|
|
350
|
-
</div>
|
|
351
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
352
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.name</p></aside></section>
|
|
353
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
354
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
355
|
-
<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>
|
|
356
|
-
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
357
|
-
</div>
|
|
358
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
359
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.node</p></aside></section>
|
|
360
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="nodeVersion" class="tsd-anchor"></a>
|
|
361
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node<wbr/>Version</span><a href="#nodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
362
|
-
<div class="tsd-signature"><span class="tsd-kind-property">node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
363
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.nodeVersion</p></aside></section>
|
|
364
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a>
|
|
365
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npmignore</span><a href="#npmignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
366
|
-
<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>
|
|
367
|
-
<div class="tsd-comment tsd-typography"><p>The .npmignore file.</p>
|
|
368
|
-
</div>
|
|
369
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
370
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmignore</p></aside></section>
|
|
371
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
372
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>outdir</span><a href="#outdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
373
|
-
<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>
|
|
374
|
-
<div class="tsd-comment tsd-typography"><p>Absolute output directory of this project.</p>
|
|
375
|
-
</div>
|
|
376
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
377
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.outdir</p></aside></section>
|
|
378
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a>
|
|
379
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
380
|
-
<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>
|
|
381
|
-
<div class="tsd-comment tsd-typography"><p>API for managing the node package.</p>
|
|
382
|
-
</div>
|
|
383
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
384
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.package</p></aside></section>
|
|
385
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="parent" class="tsd-anchor"></a>
|
|
386
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
387
|
-
<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>
|
|
388
|
-
<div class="tsd-comment tsd-typography"><p>A parent project. If undefined, this is the root project.</p>
|
|
389
|
-
</div>
|
|
390
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
391
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.parent</p></aside></section>
|
|
392
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" class="tsd-anchor"></a>
|
|
393
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier</span><a href="#prettier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
394
|
-
<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">
|
|
395
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.prettier</p></aside></section>
|
|
396
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectBuild" class="tsd-anchor"></a>
|
|
397
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project<wbr/>Build</span><a href="#projectBuild" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
398
|
-
<div class="tsd-signature"><span class="tsd-kind-property">project<wbr/>Build</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ProjectBuild</span></div>
|
|
399
|
-
<div class="tsd-comment tsd-typography"><p>Manages the build process of the project.</p>
|
|
400
|
-
</div>
|
|
401
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
402
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectBuild</p></aside></section>
|
|
403
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectType" class="tsd-anchor"></a>
|
|
404
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project<wbr/>Type</span><a href="#projectType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
405
|
-
<div class="tsd-signature"><span class="tsd-kind-property">project<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ProjectType</span></div><aside class="tsd-sources">
|
|
406
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectType</p></aside></section>
|
|
407
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publisher" class="tsd-anchor"></a>
|
|
408
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">publisher</span><a href="#publisher" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
409
|
-
<div class="tsd-signature"><span class="tsd-kind-property">publisher</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Publisher</span></div>
|
|
410
|
-
<div class="tsd-comment tsd-typography"><p>Package publisher. This will be <code>undefined</code> if the project does not have a
|
|
141
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.initProject</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">jest</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Jest</span></div><div class="tsd-comment tsd-typography"><p>The Jest configuration (if enabled)</p>
|
|
142
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.jest</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="libdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">libdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The directory in which compiled .js files reside.</p>
|
|
143
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.libdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>Logging utilities.</p>
|
|
144
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.logger</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Project name.</p>
|
|
145
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.name</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
146
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.node</p></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="nodeversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.nodeVersion</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmignore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFile</span></div><div class="tsd-comment tsd-typography"><p>The .npmignore file.</p>
|
|
147
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmignore</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Absolute output directory of this project.</p>
|
|
148
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.outdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">package</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NodePackage</span></div><div class="tsd-comment tsd-typography"><p>API for managing the node package.</p>
|
|
149
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.package</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="parent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span></div><div class="tsd-comment tsd-typography"><p>A parent project. If undefined, this is the root project.</p>
|
|
150
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.parent</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prettier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Prettier</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.prettier</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectbuild" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>Manages the build process of the project.</p>
|
|
151
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectBuild</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projecttype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>project<wbr/>Type</span><a href="#projecttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projectType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProjectType</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publisher" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="deprecated">publisher</span><a href="#publisher" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publisher</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Publisher</span></div><div class="tsd-comment tsd-typography"><p>Package publisher. This will be <code>undefined</code> if the project does not have a
|
|
411
152
|
release workflow.</p>
|
|
412
|
-
</div>
|
|
413
|
-
<div class="tsd-comment tsd-typography">
|
|
414
|
-
<
|
|
415
|
-
</div><aside class="tsd-sources">
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
<div class="tsd-signature"><span class="tsd-kind-property">
|
|
420
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
421
|
-
</div>
|
|
422
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
423
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.release</p></aside></section>
|
|
424
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runScriptCommand" class="tsd-anchor"></a>
|
|
425
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
426
|
-
<div class="tsd-signature"><span class="tsd-kind-property">run<wbr/>Script<wbr/>Command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
427
|
-
<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>
|
|
428
|
-
</div>
|
|
429
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
430
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runScriptCommand</p></aside></section>
|
|
431
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="srcdir" class="tsd-anchor"></a>
|
|
432
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
433
|
-
<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>
|
|
434
|
-
<div class="tsd-comment tsd-typography"><p>The directory in which the .ts sources reside.</p>
|
|
435
|
-
</div>
|
|
436
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
437
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.srcdir</p></aside></section>
|
|
438
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tasks" class="tsd-anchor"></a>
|
|
439
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tasks</span><a href="#tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
440
|
-
<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>
|
|
441
|
-
<div class="tsd-comment tsd-typography"><p>Project tasks.</p>
|
|
442
|
-
</div>
|
|
443
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
444
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tasks</p></aside></section>
|
|
445
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testdir" class="tsd-anchor"></a>
|
|
446
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>testdir</span><a href="#testdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
447
|
-
<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>
|
|
448
|
-
<div class="tsd-comment tsd-typography"><p>The directory in which tests reside.</p>
|
|
449
|
-
</div>
|
|
450
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
451
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testdir</p></aside></section>
|
|
452
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a>
|
|
453
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig</span><a href="#tsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
454
|
-
<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">
|
|
455
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfig</p></aside></section>
|
|
456
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDev" class="tsd-anchor"></a>
|
|
457
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev</span><a href="#tsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
458
|
-
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Dev</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">TypescriptConfig</span></div>
|
|
459
|
-
<div class="tsd-comment tsd-typography"><p>A typescript configuration file which covers all files (sources, tests, projen).</p>
|
|
460
|
-
</div>
|
|
461
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
462
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigDev</p></aside></section>
|
|
463
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigEslint" class="tsd-anchor"></a>
|
|
464
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Eslint</span><a href="#tsconfigEslint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
465
|
-
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TypescriptConfig</span></div><aside class="tsd-sources">
|
|
466
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigEslint</p></aside></section>
|
|
467
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="upgradeWorkflow" class="tsd-anchor"></a>
|
|
468
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>upgrade<wbr/>Workflow</span><a href="#upgradeWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
469
|
-
<div class="tsd-signature"><span class="tsd-kind-property">upgrade<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">UpgradeDependencies</span></div>
|
|
470
|
-
<div class="tsd-comment tsd-typography"><p>The upgrade workflow.</p>
|
|
471
|
-
</div>
|
|
472
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
473
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.upgradeWorkflow</p></aside></section>
|
|
474
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a>
|
|
475
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
476
|
-
<div class="tsd-signature"><span class="tsd-kind-property">vscode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">VsCode</span></div>
|
|
477
|
-
<div class="tsd-comment tsd-typography"><p>Access all VSCode components.</p>
|
|
153
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>release.publisher</code>.</p>
|
|
154
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.publisher</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Release</span></div><div class="tsd-comment tsd-typography"><p>Release management.</p>
|
|
155
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.release</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runscriptcommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><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>
|
|
156
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runScriptCommand</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="srcdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">srcdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The directory in which the .ts sources reside.</p>
|
|
157
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.srcdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tasks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>Project tasks.</p>
|
|
158
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tasks</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testdir" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">testdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The directory in which tests reside.</p>
|
|
159
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testdir</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfig</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfig</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigdev" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tsconfigDev</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypescriptConfig</span></div><div class="tsd-comment tsd-typography"><p>A typescript configuration file which covers all files (sources, tests, projen).</p>
|
|
160
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigDev</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigeslint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigEslint</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="upgradeworkflow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>The upgrade workflow.</p>
|
|
161
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.upgradeWorkflow</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vscode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">VsCode</span></div><div class="tsd-comment tsd-typography"><p>Access all VSCode components.</p>
|
|
478
162
|
<p>This will be <code>undefined</code> for subprojects.</p>
|
|
479
|
-
</div>
|
|
480
|
-
|
|
481
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.vscode</p></aside></section>
|
|
482
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchTask" class="tsd-anchor"></a>
|
|
483
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Task</span><a href="#watchTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
484
|
-
<div class="tsd-signature"><span class="tsd-kind-property">watch<wbr/>Task</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Task</span></div>
|
|
485
|
-
<div class="tsd-comment tsd-typography"><p>The "watch" task.</p>
|
|
486
|
-
</div>
|
|
487
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
488
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.watchTask</p></aside></section>
|
|
489
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="workflowBootstrapSteps" class="tsd-anchor"></a>
|
|
490
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowBootstrapSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
491
|
-
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Bootstrap<wbr/>Steps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
492
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowBootstrapSteps</p></aside></section>
|
|
493
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="workflowPackageCache" class="tsd-anchor"></a>
|
|
494
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
495
|
-
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Package<wbr/>Cache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
496
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowPackageCache</p></aside></section>
|
|
497
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="DEFAULT_TASK" class="tsd-anchor"></a>
|
|
498
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>DEFAULT_<wbr/>TASK</span><a href="#DEFAULT_TASK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
499
|
-
<div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>TASK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"default"</span><span class="tsd-signature-symbol"> = "default"</span></div>
|
|
500
|
-
<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
|
|
163
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.vscode</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchtask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class="tsd-comment tsd-typography"><p>The "watch" task.</p>
|
|
164
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.watchTask</p></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="workflowbootstrapsteps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowBootstrapSteps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowBootstrapSteps</p></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="workflowpackagecache" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowPackageCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowPackageCache</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="default_task" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><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
|
|
501
165
|
this task should synthesize the project files.</p>
|
|
502
|
-
</div>
|
|
503
|
-
|
|
504
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.
|
|
505
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="
|
|
506
|
-
<
|
|
507
|
-
<div class="tsd-signature"><span class="tsd-kind-
|
|
508
|
-
|
|
509
|
-
<section class="tsd-panel
|
|
510
|
-
<
|
|
511
|
-
<
|
|
512
|
-
<h3 class="tsd-anchor-link"><span>
|
|
513
|
-
<
|
|
514
|
-
<
|
|
515
|
-
<li class="tsd-description">
|
|
516
|
-
|
|
517
|
-
<div class="tsd-comment tsd-typography">
|
|
518
|
-
|
|
519
|
-
</div><aside class="tsd-sources">
|
|
520
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.
|
|
521
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildTask" class="tsd-anchor"></a>
|
|
522
|
-
<h3 class="tsd-anchor-link"><span>build<wbr/>Task</span><a href="#buildTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
523
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
524
|
-
<li class="tsd-signature" id="buildTask.buildTask-1"><span class="tsd-signature-symbol">get</span> buildTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
525
|
-
<li class="tsd-description">
|
|
526
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
527
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildTask</p></aside></li></ul></section>
|
|
528
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflowJobId" class="tsd-anchor"></a>
|
|
529
|
-
<h3 class="tsd-anchor-link"><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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
530
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
531
|
-
<li class="tsd-signature" id="buildWorkflowJobId.buildWorkflowJobId-1"><span class="tsd-signature-symbol">get</span> buildWorkflowJobId<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
|
|
532
|
-
<li class="tsd-description">
|
|
533
|
-
<div class="tsd-comment tsd-typography"><p>The job ID of the build workflow.</p>
|
|
534
|
-
</div>
|
|
535
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
|
|
536
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
537
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflowJobId</p></aside></li></ul></section>
|
|
538
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersion" class="tsd-anchor"></a>
|
|
539
|
-
<h3 class="tsd-anchor-link"><span>cdk<wbr/>Version</span><a href="#cdkVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
540
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
541
|
-
<li class="tsd-signature" id="cdkVersion.cdkVersion-1"><span class="tsd-signature-symbol">get</span> cdkVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
542
|
-
<li class="tsd-description">
|
|
543
|
-
<div class="tsd-comment tsd-typography"><p>The CDK version this app is using.</p>
|
|
544
|
-
</div>
|
|
545
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
546
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
547
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkVersion</p></aside></li></ul></section>
|
|
548
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="compileTask" class="tsd-anchor"></a>
|
|
549
|
-
<h3 class="tsd-anchor-link"><span>compile<wbr/>Task</span><a href="#compileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
550
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
551
|
-
<li class="tsd-signature" id="compileTask.compileTask-1"><span class="tsd-signature-symbol">get</span> compileTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
552
|
-
<li class="tsd-description">
|
|
553
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
554
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.compileTask</p></aside></li></ul></section>
|
|
555
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="components" class="tsd-anchor"></a>
|
|
556
|
-
<h3 class="tsd-anchor-link"><span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
557
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
558
|
-
<li class="tsd-signature" id="components.components-1"><span class="tsd-signature-symbol">get</span> components<span class="tsd-signature-symbol">(</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></li>
|
|
559
|
-
<li class="tsd-description">
|
|
560
|
-
<div class="tsd-comment tsd-typography"><p>Returns all the components within this project.</p>
|
|
561
|
-
</div>
|
|
562
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Component</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
563
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
564
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.components</p></aside></li></ul></section>
|
|
565
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ejected" class="tsd-anchor"></a>
|
|
566
|
-
<h3 class="tsd-anchor-link"><span>ejected</span><a href="#ejected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
567
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
568
|
-
<li class="tsd-signature" id="ejected.ejected-1"><span class="tsd-signature-symbol">get</span> ejected<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
569
|
-
<li class="tsd-description">
|
|
570
|
-
<div class="tsd-comment tsd-typography"><p>Whether or not the project is being ejected.</p>
|
|
571
|
-
</div>
|
|
572
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
573
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
574
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.ejected</p></aside></li></ul></section>
|
|
575
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" class="tsd-anchor"></a>
|
|
576
|
-
<h3 class="tsd-anchor-link"><span>entrypoint</span><a href="#entrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
577
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
578
|
-
<li class="tsd-signature" id="entrypoint.entrypoint-1"><span class="tsd-signature-symbol">get</span> entrypoint<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
579
|
-
<li class="tsd-description">
|
|
580
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
581
|
-
<div class="tsd-comment tsd-typography">
|
|
582
|
-
<h4>Deprecated</h4><p>use <code>package.entrypoint</code></p>
|
|
583
|
-
</div><aside class="tsd-sources">
|
|
584
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.entrypoint</p></aside></li></ul></section>
|
|
585
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="files" class="tsd-anchor"></a>
|
|
586
|
-
<h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
587
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
588
|
-
<li class="tsd-signature" id="files.files-1"><span class="tsd-signature-symbol">get</span> files<span class="tsd-signature-symbol">(</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></li>
|
|
589
|
-
<li class="tsd-description">
|
|
590
|
-
<div class="tsd-comment tsd-typography"><p>All files in this project.</p>
|
|
591
|
-
</div>
|
|
592
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FileBase</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
593
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
594
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.files</p></aside></li></ul></section>
|
|
595
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="manifest" class="tsd-anchor"></a>
|
|
596
|
-
<h3 class="tsd-anchor-link"><span>manifest</span><a href="#manifest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
597
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
598
|
-
<li class="tsd-signature" id="manifest.manifest-1"><span class="tsd-signature-symbol">get</span> manifest<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
599
|
-
<li class="tsd-description">
|
|
600
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
601
|
-
<div class="tsd-comment tsd-typography">
|
|
602
|
-
<h4>Deprecated</h4><p>use <code>package.addField(x, y)</code></p>
|
|
603
|
-
</div><aside class="tsd-sources">
|
|
604
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.manifest</p></aside></li></ul></section>
|
|
605
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" class="tsd-anchor"></a>
|
|
606
|
-
<h3 class="tsd-anchor-link"><span>max<wbr/>Node<wbr/>Version</span><a href="#maxNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
607
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
608
|
-
<li class="tsd-signature" id="maxNodeVersion.maxNodeVersion-1"><span class="tsd-signature-symbol">get</span> maxNodeVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
|
|
609
|
-
<li class="tsd-description">
|
|
610
|
-
<div class="tsd-comment tsd-typography"><p>Maximum node version required by this package.</p>
|
|
611
|
-
</div>
|
|
612
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
|
|
613
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
614
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.maxNodeVersion</p></aside></li></ul></section>
|
|
615
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" class="tsd-anchor"></a>
|
|
616
|
-
<h3 class="tsd-anchor-link"><span>min<wbr/>Node<wbr/>Version</span><a href="#minNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
617
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
618
|
-
<li class="tsd-signature" id="minNodeVersion.minNodeVersion-1"><span class="tsd-signature-symbol">get</span> minNodeVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
|
|
619
|
-
<li class="tsd-description">
|
|
620
|
-
<div class="tsd-comment tsd-typography"><p>Minimum node.js version required by this package.</p>
|
|
621
|
-
</div>
|
|
622
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
|
|
623
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
624
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.minNodeVersion</p></aside></li></ul></section>
|
|
625
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmrc" class="tsd-anchor"></a>
|
|
626
|
-
<h3 class="tsd-anchor-link"><span>npmrc</span><a href="#npmrc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
627
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
628
|
-
<li class="tsd-signature" id="npmrc.npmrc-1"><span class="tsd-signature-symbol">get</span> npmrc<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">NpmConfig</span></li>
|
|
629
|
-
<li class="tsd-description">
|
|
630
|
-
<div class="tsd-comment tsd-typography"><p>The .npmrc file</p>
|
|
631
|
-
</div>
|
|
632
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">NpmConfig</span></h4>
|
|
633
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
634
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmrc</p></aside></li></ul></section>
|
|
635
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
636
|
-
<h3 class="tsd-anchor-link"><span>package<wbr/>Manager</span><a href="#packageManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
637
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
638
|
-
<li class="tsd-signature" id="packageManager.packageManager-1"><span class="tsd-signature-symbol">get</span> packageManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">NodePackageManager</span></li>
|
|
639
|
-
<li class="tsd-description">
|
|
640
|
-
<div class="tsd-comment tsd-typography"><p>The package manager to use.</p>
|
|
641
|
-
</div>
|
|
642
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">NodePackageManager</span></h4>
|
|
643
|
-
<div class="tsd-comment tsd-typography">
|
|
644
|
-
<h4>Deprecated</h4><p>use <code>package.packageManager</code></p>
|
|
645
|
-
</div><aside class="tsd-sources">
|
|
646
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageManager</p></aside></li></ul></section>
|
|
647
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageTask" class="tsd-anchor"></a>
|
|
648
|
-
<h3 class="tsd-anchor-link"><span>package<wbr/>Task</span><a href="#packageTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
649
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
650
|
-
<li class="tsd-signature" id="packageTask.packageTask-1"><span class="tsd-signature-symbol">get</span> packageTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
651
|
-
<li class="tsd-description">
|
|
652
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
653
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageTask</p></aside></li></ul></section>
|
|
654
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postCompileTask" class="tsd-anchor"></a>
|
|
655
|
-
<h3 class="tsd-anchor-link"><span>post<wbr/>Compile<wbr/>Task</span><a href="#postCompileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
656
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
657
|
-
<li class="tsd-signature" id="postCompileTask.postCompileTask-1"><span class="tsd-signature-symbol">get</span> postCompileTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
658
|
-
<li class="tsd-description">
|
|
659
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
660
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postCompileTask</p></aside></li></ul></section>
|
|
661
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="preCompileTask" class="tsd-anchor"></a>
|
|
662
|
-
<h3 class="tsd-anchor-link"><span>pre<wbr/>Compile<wbr/>Task</span><a href="#preCompileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
663
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
664
|
-
<li class="tsd-signature" id="preCompileTask.preCompileTask-1"><span class="tsd-signature-symbol">get</span> preCompileTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
665
|
-
<li class="tsd-description">
|
|
666
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
667
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preCompileTask</p></aside></li></ul></section>
|
|
668
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCommand" class="tsd-anchor"></a>
|
|
669
|
-
<h3 class="tsd-anchor-link"><span>projen<wbr/>Command</span><a href="#projenCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
670
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
671
|
-
<li class="tsd-signature" id="projenCommand.projenCommand-1"><span class="tsd-signature-symbol">get</span> projenCommand<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
672
|
-
<li class="tsd-description">
|
|
673
|
-
<div class="tsd-comment tsd-typography"><p>The command to use in order to run the projen CLI.</p>
|
|
674
|
-
</div>
|
|
675
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
676
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
677
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projenCommand</p></aside></li></ul></section>
|
|
678
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="root" class="tsd-anchor"></a>
|
|
679
|
-
<h3 class="tsd-anchor-link"><span>root</span><a href="#root" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
680
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
681
|
-
<li class="tsd-signature" id="root.root-1"><span class="tsd-signature-symbol">get</span> root<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Project</span></li>
|
|
682
|
-
<li class="tsd-description">
|
|
683
|
-
<div class="tsd-comment tsd-typography"><p>The root project.</p>
|
|
684
|
-
</div>
|
|
685
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Project</span></h4>
|
|
686
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
687
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.root</p></aside></li></ul></section>
|
|
688
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="subprojects" class="tsd-anchor"></a>
|
|
689
|
-
<h3 class="tsd-anchor-link"><span>subprojects</span><a href="#subprojects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
690
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
691
|
-
<li class="tsd-signature" id="subprojects.subprojects-1"><span class="tsd-signature-symbol">get</span> subprojects<span class="tsd-signature-symbol">(</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></li>
|
|
692
|
-
<li class="tsd-description">
|
|
693
|
-
<div class="tsd-comment tsd-typography"><p>Returns all the subprojects within this project.</p>
|
|
694
|
-
</div>
|
|
695
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Project</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
696
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
697
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.subprojects</p></aside></li></ul></section>
|
|
698
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testTask" class="tsd-anchor"></a>
|
|
699
|
-
<h3 class="tsd-anchor-link"><span>test<wbr/>Task</span><a href="#testTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
700
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
701
|
-
<li class="tsd-signature" id="testTask.testTask-1"><span class="tsd-signature-symbol">get</span> testTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
702
|
-
<li class="tsd-description">
|
|
703
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
704
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testTask</p></aside></li></ul></section></section>
|
|
705
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
706
|
-
<h2>Methods</h2>
|
|
707
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addBins" class="tsd-anchor"></a>
|
|
708
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Bins</span><a href="#addBins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
709
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
710
|
-
<li class="tsd-signature tsd-anchor-link" id="addBins.addBins-1"><span class="tsd-kind-call-signature">add<wbr/>Bins</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bins</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addBins.addBins-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
711
|
-
<li class="tsd-description">
|
|
712
|
-
<div class="tsd-parameters">
|
|
713
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
714
|
-
<ul class="tsd-parameter-list">
|
|
715
|
-
<li>
|
|
716
|
-
<h5><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></h5></li></ul></div>
|
|
717
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
718
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBins</p></aside></li></ul></section>
|
|
719
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addBundledDeps" class="tsd-anchor"></a>
|
|
720
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Bundled<wbr/>Deps</span><a href="#addBundledDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
721
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
722
|
-
<li class="tsd-signature tsd-anchor-link" id="addBundledDeps.addBundledDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Bundled<wbr/>Deps</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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addBundledDeps.addBundledDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
723
|
-
<li class="tsd-description">
|
|
724
|
-
<div class="tsd-comment tsd-typography"><p>Defines bundled dependencies.</p>
|
|
166
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TASK</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="default_ts_jest_tranform_pattern" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TS_JEST_TRANFORM_PATTERN</p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowlibrarydependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowlibrarydependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="allowlibrarydependencies-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">allowLibraryDependencies</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>package.allowLibraryDependencies</code></p>
|
|
167
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.allowLibraryDependencies</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildtask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build<wbr/>Task</span><a href="#buildtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="buildtask-1"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildworkflowjobid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="buildworkflowjobid-1"><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The job ID of the build workflow.</p>
|
|
168
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflowJobId</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cdk<wbr/>Version</span><a href="#cdkversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="cdkversion-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The CDK version this app is using.</p>
|
|
169
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="compiletask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>compile<wbr/>Task</span><a href="#compiletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="compiletask-1"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.compileTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="components" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="components-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all the components within this project.</p>
|
|
170
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.components</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ejected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ejected</span><a href="#ejected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="ejected-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether or not the project is being ejected.</p>
|
|
171
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.ejected</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>entrypoint</span><a href="#entrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="entrypoint-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">entrypoint</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>package.entrypoint</code></p>
|
|
172
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.entrypoint</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="files" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="files-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>All files in this project.</p>
|
|
173
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FileBase</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.files</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="manifest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>manifest</span><a href="#manifest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="manifest-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">manifest</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-3" class="tsd-anchor"></a>Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>package.addField(x, y)</code></p>
|
|
174
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.manifest</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxnodeversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Node<wbr/>Version</span><a href="#maxnodeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="maxnodeversion-1"><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Maximum node version supported by this package.</p>
|
|
175
|
+
<p>The value indicates the package is incompatible with newer versions.</p>
|
|
176
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.maxNodeVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minnodeversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>min<wbr/>Node<wbr/>Version</span><a href="#minnodeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="minnodeversion-1"><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The minimum node version required by this package to function.</p>
|
|
177
|
+
<p>This value indicates the package is incompatible with older versions.</p>
|
|
178
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.minNodeVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmrc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>npmrc</span><a href="#npmrc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="npmrc-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The .npmrc file</p>
|
|
179
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">NpmConfig</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmrc</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packagemanager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>package<wbr/>Manager</span><a href="#packagemanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="packagemanager-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">packageManager</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NodePackageManager</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The package manager to use.</p>
|
|
180
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">NodePackageManager</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-4" class="tsd-anchor"></a>Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>package.packageManager</code></p>
|
|
181
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageManager</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packagetask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>package<wbr/>Task</span><a href="#packagetask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="packagetask-1"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postcompiletask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>post<wbr/>Compile<wbr/>Task</span><a href="#postcompiletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="postcompiletask-1"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postCompileTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="precompiletask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pre<wbr/>Compile<wbr/>Task</span><a href="#precompiletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="precompiletask-1"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preCompileTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projencommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>projen<wbr/>Command</span><a href="#projencommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="projencommand-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The command to use in order to run the projen CLI.</p>
|
|
182
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projenCommand</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="root" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>root</span><a href="#root" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="root-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The root project.</p>
|
|
183
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Project</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.root</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="subprojects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subprojects</span><a href="#subprojects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="subprojects-1"><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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all the subprojects within this project.</p>
|
|
184
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.subprojects</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testtask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>test<wbr/>Task</span><a href="#testtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="testtask-1"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testTask</p></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addbins" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Bins</span><a href="#addbins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addbins-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBins</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addbundleddeps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Bundled<wbr/>Deps</span><a href="#addbundleddeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addbundleddeps-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines bundled dependencies.</p>
|
|
725
185
|
<p>Bundled dependencies will be added as normal dependencies as well as to the
|
|
726
186
|
<code>bundledDependencies</code> section of your <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>
|
|
732
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <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></h5>
|
|
733
|
-
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
187
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
734
188
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
735
189
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
736
190
|
<code>module@^7</code>.</p>
|
|
737
|
-
</div><
|
|
738
|
-
|
|
739
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
744
|
-
<li class="tsd-signature tsd-anchor-link" id="addCdkDependency.addCdkDependency-1"><span class="tsd-kind-call-signature">add<wbr/>Cdk<wbr/>Dependency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addCdkDependency.addCdkDependency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
745
|
-
<li class="tsd-description">
|
|
746
|
-
<div class="tsd-comment tsd-typography"><p>Adds an AWS CDK module dependencies</p>
|
|
747
|
-
</div>
|
|
748
|
-
<div class="tsd-parameters">
|
|
749
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
750
|
-
<ul class="tsd-parameter-list">
|
|
751
|
-
<li>
|
|
752
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
753
|
-
<div class="tsd-comment tsd-typography"><p>The list of modules to depend on</p>
|
|
754
|
-
</div><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
|
|
755
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
756
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
757
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addCdkDependency</p></aside></li></ul></section>
|
|
758
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addCompileCommand" class="tsd-anchor"></a>
|
|
759
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Compile<wbr/>Command</span><a href="#addCompileCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
760
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
761
|
-
<li class="tsd-signature tsd-anchor-link" id="addCompileCommand.addCompileCommand-1"><span class="tsd-kind-call-signature">add<wbr/>Compile<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addCompileCommand.addCompileCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
762
|
-
<li class="tsd-description">
|
|
763
|
-
<div class="tsd-comment tsd-typography"><p>DEPRECATED</p>
|
|
764
|
-
</div>
|
|
765
|
-
<div class="tsd-parameters">
|
|
766
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
767
|
-
<ul class="tsd-parameter-list">
|
|
768
|
-
<li>
|
|
769
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
|
|
770
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
771
|
-
<div class="tsd-comment tsd-typography">
|
|
772
|
-
<h4>Deprecated</h4><p>use <code>project.compileTask.exec()</code></p>
|
|
773
|
-
</div><aside class="tsd-sources">
|
|
774
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addCompileCommand</p></aside></li></ul></section>
|
|
775
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addDeps" class="tsd-anchor"></a>
|
|
776
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Deps</span><a href="#addDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
777
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
778
|
-
<li class="tsd-signature tsd-anchor-link" id="addDeps.addDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Deps</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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDeps.addDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
779
|
-
<li class="tsd-description">
|
|
780
|
-
<div class="tsd-comment tsd-typography"><p>Defines normal dependencies.</p>
|
|
781
|
-
</div>
|
|
782
|
-
<div class="tsd-parameters">
|
|
783
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
784
|
-
<ul class="tsd-parameter-list">
|
|
785
|
-
<li>
|
|
786
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <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></h5>
|
|
787
|
-
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
191
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBundledDeps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addcdkdependency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Cdk<wbr/>Dependency</span><a href="#addcdkdependency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addcdkdependency-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addCdkDependency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</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="#addcdkdependency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an AWS CDK module dependencies</p>
|
|
192
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The list of modules to depend on</p>
|
|
193
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addCdkDependency</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addcompilecommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">add<wbr/>Compile<wbr/>Command</span><a href="#addcompilecommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addcompilecommand-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addCompileCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</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="#addcompilecommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>DEPRECATED</p>
|
|
194
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-5" class="tsd-anchor"></a>Deprecated<a href="#deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>project.compileTask.exec()</code></p>
|
|
195
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addCompileCommand</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="adddeps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Deps</span><a href="#adddeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="adddeps-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines normal dependencies.</p>
|
|
196
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
788
197
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
789
198
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
790
199
|
<code>module@^7</code>.</p>
|
|
791
|
-
</div><
|
|
792
|
-
|
|
793
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
794
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDeps</p></aside></li></ul></section>
|
|
795
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addDevDeps" class="tsd-anchor"></a>
|
|
796
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Dev<wbr/>Deps</span><a href="#addDevDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
797
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
798
|
-
<li class="tsd-signature tsd-anchor-link" id="addDevDeps.addDevDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Dev<wbr/>Deps</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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDevDeps.addDevDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
799
|
-
<li class="tsd-description">
|
|
800
|
-
<div class="tsd-comment tsd-typography"><p>Defines development/test dependencies.</p>
|
|
801
|
-
</div>
|
|
802
|
-
<div class="tsd-parameters">
|
|
803
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
804
|
-
<ul class="tsd-parameter-list">
|
|
805
|
-
<li>
|
|
806
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <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></h5>
|
|
807
|
-
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
200
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDeps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="adddevdeps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Dev<wbr/>Deps</span><a href="#adddevdeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="adddevdeps-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines development/test dependencies.</p>
|
|
201
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
808
202
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
809
203
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
810
204
|
<code>module@^7</code>.</p>
|
|
811
|
-
</div><
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.
|
|
815
|
-
<
|
|
816
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>
|
|
817
|
-
|
|
818
|
-
<li class="tsd-signature tsd-anchor-link" id="
|
|
819
|
-
|
|
820
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
821
|
-
|
|
822
|
-
</div>
|
|
823
|
-
<div class="tsd-
|
|
824
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
825
|
-
<ul class="tsd-parameter-list">
|
|
826
|
-
<li>
|
|
827
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <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></h5>
|
|
828
|
-
<div class="tsd-comment tsd-typography"><p>The glob patterns to match</p>
|
|
829
|
-
</div><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
|
|
830
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
831
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
832
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addExcludeFromCleanup</p></aside></li></ul></section>
|
|
833
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addFields" class="tsd-anchor"></a>
|
|
834
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Fields</span><a href="#addFields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
835
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
836
|
-
<li class="tsd-signature tsd-anchor-link" id="addFields.addFields-1"><span class="tsd-kind-call-signature">add<wbr/>Fields</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-type">void</span><a href="#addFields.addFields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
837
|
-
<li class="tsd-description">
|
|
838
|
-
<div class="tsd-comment tsd-typography"><p>Directly set fields in <code>package.json</code>.</p>
|
|
839
|
-
</div>
|
|
840
|
-
<div class="tsd-parameters">
|
|
841
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
842
|
-
<ul class="tsd-parameter-list">
|
|
843
|
-
<li>
|
|
844
|
-
<h5><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
845
|
-
<div class="tsd-comment tsd-typography"><p>The fields to set</p>
|
|
846
|
-
</div>
|
|
847
|
-
<ul class="tsd-parameters">
|
|
848
|
-
<li class="tsd-parameter-index-signature">
|
|
849
|
-
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li></ul></div>
|
|
850
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
851
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
852
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addFields</p></aside></li></ul></section>
|
|
853
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addGitIgnore" class="tsd-anchor"></a>
|
|
854
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Git<wbr/>Ignore</span><a href="#addGitIgnore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
855
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
856
|
-
<li class="tsd-signature tsd-anchor-link" id="addGitIgnore.addGitIgnore-1"><span class="tsd-kind-call-signature">add<wbr/>Git<wbr/>Ignore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addGitIgnore.addGitIgnore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
857
|
-
<li class="tsd-description">
|
|
858
|
-
<div class="tsd-comment tsd-typography"><p>Adds a .gitignore pattern.</p>
|
|
859
|
-
</div>
|
|
860
|
-
<div class="tsd-parameters">
|
|
861
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
862
|
-
<ul class="tsd-parameter-list">
|
|
863
|
-
<li>
|
|
864
|
-
<h5><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></h5>
|
|
865
|
-
<div class="tsd-comment tsd-typography"><p>The glob pattern to ignore.</p>
|
|
866
|
-
</div></li></ul></div>
|
|
867
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
868
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
869
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addGitIgnore</p></aside></li></ul></section>
|
|
870
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addKeywords" class="tsd-anchor"></a>
|
|
871
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Keywords</span><a href="#addKeywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
872
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
873
|
-
<li class="tsd-signature tsd-anchor-link" id="addKeywords.addKeywords-1"><span class="tsd-kind-call-signature">add<wbr/>Keywords</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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addKeywords.addKeywords-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
874
|
-
<li class="tsd-description">
|
|
875
|
-
<div class="tsd-comment tsd-typography"><p>Adds keywords to package.json (deduplicated)</p>
|
|
876
|
-
</div>
|
|
877
|
-
<div class="tsd-parameters">
|
|
878
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
879
|
-
<ul class="tsd-parameter-list">
|
|
880
|
-
<li>
|
|
881
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <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></h5>
|
|
882
|
-
<div class="tsd-comment tsd-typography"><p>The keywords to add</p>
|
|
883
|
-
</div><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
|
|
884
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
885
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
886
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addKeywords</p></aside></li></ul></section>
|
|
887
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addPackageIgnore" class="tsd-anchor"></a>
|
|
888
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Package<wbr/>Ignore</span><a href="#addPackageIgnore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
889
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
890
|
-
<li class="tsd-signature tsd-anchor-link" id="addPackageIgnore.addPackageIgnore-1"><span class="tsd-kind-call-signature">add<wbr/>Package<wbr/>Ignore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPackageIgnore.addPackageIgnore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
891
|
-
<li class="tsd-description">
|
|
892
|
-
<div class="tsd-comment tsd-typography"><p>Adds patterns to be ignored by npm.</p>
|
|
893
|
-
</div>
|
|
894
|
-
<div class="tsd-parameters">
|
|
895
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
896
|
-
<ul class="tsd-parameter-list">
|
|
897
|
-
<li>
|
|
898
|
-
<h5><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></h5>
|
|
899
|
-
<div class="tsd-comment tsd-typography"><p>The pattern to ignore.</p>
|
|
900
|
-
</div></li></ul></div>
|
|
901
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
902
|
-
<div class="tsd-comment tsd-typography">
|
|
903
|
-
<h4>Remarks</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>
|
|
904
|
-
</div><aside class="tsd-sources">
|
|
905
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPackageIgnore</p></aside></li></ul></section>
|
|
906
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addPeerDeps" class="tsd-anchor"></a>
|
|
907
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Peer<wbr/>Deps</span><a href="#addPeerDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
908
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
909
|
-
<li class="tsd-signature tsd-anchor-link" id="addPeerDeps.addPeerDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Peer<wbr/>Deps</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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPeerDeps.addPeerDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
910
|
-
<li class="tsd-description">
|
|
911
|
-
<div class="tsd-comment tsd-typography"><p>Defines peer dependencies.</p>
|
|
205
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDevDeps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addexcludefromcleanup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addexcludefromcleanup-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Exclude the matching files from pre-synth cleanup. Can be used when, for example, some
|
|
206
|
+
source files include the projen marker and we don't want them to be erased during synth.</p>
|
|
207
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>The glob patterns to match</p>
|
|
208
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addExcludeFromCleanup</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addfields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Fields</span><a href="#addfields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addfields-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Directly set fields in <code>package.json</code>.</p>
|
|
209
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>The fields to set</p>
|
|
210
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addFields</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addgitignore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Git<wbr/>Ignore</span><a href="#addgitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addgitignore-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a .gitignore pattern.</p>
|
|
211
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The glob pattern to ignore.</p>
|
|
212
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addGitIgnore</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addkeywords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Keywords</span><a href="#addkeywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addkeywords-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds keywords to package.json (deduplicated)</p>
|
|
213
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>The keywords to add</p>
|
|
214
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addKeywords</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addpackageignore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Package<wbr/>Ignore</span><a href="#addpackageignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addpackageignore-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds patterns to be ignored by npm.</p>
|
|
215
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The pattern to ignore.</p>
|
|
216
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link"><a id="remarks" class="tsd-anchor"></a>Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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>
|
|
217
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPackageIgnore</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addpeerdeps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Peer<wbr/>Deps</span><a href="#addpeerdeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addpeerdeps-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines peer dependencies.</p>
|
|
912
218
|
<p>When adding peer dependencies, a devDependency will also be added on the
|
|
913
219
|
pinned version of the declared peer. This will ensure that you are testing
|
|
914
220
|
your code against the minimum version required from your consumers.</p>
|
|
915
|
-
</div>
|
|
916
|
-
<div class="tsd-parameters">
|
|
917
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
918
|
-
<ul class="tsd-parameter-list">
|
|
919
|
-
<li>
|
|
920
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <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></h5>
|
|
921
|
-
<div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
221
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>Names modules to install. By default, the the dependency will
|
|
922
222
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
923
223
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
924
224
|
<code>module@^7</code>.</p>
|
|
925
|
-
</div><
|
|
926
|
-
|
|
927
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
928
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPeerDeps</p></aside></li></ul></section>
|
|
929
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addScripts" class="tsd-anchor"></a>
|
|
930
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Scripts</span><a href="#addScripts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
931
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
932
|
-
<li class="tsd-signature tsd-anchor-link" id="addScripts.addScripts-1"><span class="tsd-kind-call-signature">add<wbr/>Scripts</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-type">void</span><a href="#addScripts.addScripts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
933
|
-
<li class="tsd-description">
|
|
934
|
-
<div class="tsd-comment tsd-typography"><p>Replaces the contents of multiple npm package.json scripts.</p>
|
|
935
|
-
</div>
|
|
936
|
-
<div class="tsd-parameters">
|
|
937
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
938
|
-
<ul class="tsd-parameter-list">
|
|
939
|
-
<li>
|
|
940
|
-
<h5><span class="tsd-kind-parameter">scripts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
941
|
-
<div class="tsd-comment tsd-typography"><p>The scripts to set</p>
|
|
942
|
-
</div>
|
|
943
|
-
<ul class="tsd-parameters">
|
|
944
|
-
<li class="tsd-parameter-index-signature">
|
|
945
|
-
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
|
|
946
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
947
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
948
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addScripts</p></aside></li></ul></section>
|
|
949
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addTask" class="tsd-anchor"></a>
|
|
950
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Task</span><a href="#addTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
951
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
952
|
-
<li class="tsd-signature tsd-anchor-link" id="addTask.addTask-1"><span class="tsd-kind-call-signature">add<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span><a href="#addTask.addTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
953
|
-
<li class="tsd-description">
|
|
954
|
-
<div class="tsd-comment tsd-typography"><p>Adds a new task to this project. This will fail if the project already has
|
|
225
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPeerDeps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addscripts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Scripts</span><a href="#addscripts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addscripts-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Replaces the contents of multiple npm package.json scripts.</p>
|
|
226
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>The scripts to set</p>
|
|
227
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addScripts</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addtask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Task</span><a href="#addtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addtask-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new task to this project. This will fail if the project already has
|
|
955
228
|
a task with this name.</p>
|
|
956
|
-
</div>
|
|
957
|
-
<div class="tsd-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
<li>
|
|
961
|
-
|
|
962
|
-
<div class="tsd-comment tsd-typography"><
|
|
963
|
-
</div></li>
|
|
964
|
-
<li>
|
|
965
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">TaskOptions</span></h5>
|
|
966
|
-
<div class="tsd-comment tsd-typography"><p>Task properties</p>
|
|
967
|
-
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
968
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4>
|
|
969
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
970
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTask</p></aside></li></ul></section>
|
|
971
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addTestCommand" class="tsd-anchor"></a>
|
|
972
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Test<wbr/>Command</span><a href="#addTestCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
973
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
974
|
-
<li class="tsd-signature tsd-anchor-link" id="addTestCommand.addTestCommand-1"><span class="tsd-kind-call-signature">add<wbr/>Test<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTestCommand.addTestCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
975
|
-
<li class="tsd-description">
|
|
976
|
-
<div class="tsd-comment tsd-typography"><p>DEPRECATED</p>
|
|
977
|
-
</div>
|
|
978
|
-
<div class="tsd-parameters">
|
|
979
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
980
|
-
<ul class="tsd-parameter-list">
|
|
981
|
-
<li>
|
|
982
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
|
|
983
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
984
|
-
<div class="tsd-comment tsd-typography">
|
|
985
|
-
<h4>Deprecated</h4><p>use <code>project.testTask.exec()</code></p>
|
|
986
|
-
</div><aside class="tsd-sources">
|
|
987
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTestCommand</p></aside></li></ul></section>
|
|
988
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addTip" class="tsd-anchor"></a>
|
|
989
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Tip</span><a href="#addTip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
990
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
991
|
-
<li class="tsd-signature tsd-anchor-link" id="addTip.addTip-1"><span class="tsd-kind-call-signature">add<wbr/>Tip</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTip.addTip-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
992
|
-
<li class="tsd-description">
|
|
993
|
-
<div class="tsd-comment tsd-typography"><p>Prints a "tip" message during synthesis.</p>
|
|
994
|
-
</div>
|
|
995
|
-
<div class="tsd-parameters">
|
|
996
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
997
|
-
<ul class="tsd-parameter-list">
|
|
998
|
-
<li>
|
|
999
|
-
<h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1000
|
-
<div class="tsd-comment tsd-typography"><p>The message</p>
|
|
1001
|
-
</div></li></ul></div>
|
|
1002
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1003
|
-
<div class="tsd-comment tsd-typography">
|
|
1004
|
-
<h4>Deprecated</h4><ul>
|
|
229
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The task name to add</p>
|
|
230
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">TaskOptions</span></span><div class="tsd-comment tsd-typography"><p>Task properties</p>
|
|
231
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addtestcommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">add<wbr/>Test<wbr/>Command</span><a href="#addtestcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addtestcommand-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addTestCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</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="#addtestcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>DEPRECATED</p>
|
|
232
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-6" class="tsd-anchor"></a>Deprecated<a href="#deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>project.testTask.exec()</code></p>
|
|
233
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTestCommand</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addtip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">add<wbr/>Tip</span><a href="#addtip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addtip-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addTip</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</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="#addtip-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Prints a "tip" message during synthesis.</p>
|
|
234
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The message</p>
|
|
235
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-7" class="tsd-anchor"></a>Deprecated<a href="#deprecated-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
1005
236
|
<li>use <code>project.logger.info(message)</code> to show messages during synthesis</li>
|
|
1006
237
|
</ul>
|
|
1007
|
-
</div><aside class="tsd-sources">
|
|
1008
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTip</p></aside></li></ul></section>
|
|
1009
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="annotateGenerated" class="tsd-anchor"></a>
|
|
1010
|
-
<h3 class="tsd-anchor-link"><span>annotate<wbr/>Generated</span><a href="#annotateGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1011
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1012
|
-
<li class="tsd-signature tsd-anchor-link" id="annotateGenerated.annotateGenerated-1"><span class="tsd-kind-call-signature">annotate<wbr/>Generated</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">glob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#annotateGenerated.annotateGenerated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1013
|
-
<li class="tsd-description">
|
|
1014
|
-
<div class="tsd-comment tsd-typography"><p>Marks the provided file(s) as being generated. This is achieved using the
|
|
238
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTip</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="annotategenerated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>annotate<wbr/>Generated</span><a href="#annotategenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="annotategenerated-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Marks the provided file(s) as being generated. This is achieved using the
|
|
1015
239
|
github-linguist attributes. Generated files do not count against the
|
|
1016
240
|
repository statistics and language breakdown.</p>
|
|
1017
|
-
</div>
|
|
1018
|
-
<div class="tsd-
|
|
1019
|
-
<
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
<
|
|
1023
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
1024
|
-
</div></li></ul></div>
|
|
1025
|
-
|
|
1026
|
-
<div class="tsd-comment tsd-typography">
|
|
1027
|
-
|
|
1028
|
-
</div><
|
|
1029
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.
|
|
1030
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="hasScript" class="tsd-anchor"></a>
|
|
1031
|
-
<h3 class="tsd-anchor-link"><span>has<wbr/>Script</span><a href="#hasScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1032
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1033
|
-
<li class="tsd-signature tsd-anchor-link" id="hasScript.hasScript-1"><span class="tsd-kind-call-signature">has<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasScript.hasScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1034
|
-
<li class="tsd-description">
|
|
1035
|
-
<div class="tsd-comment tsd-typography"><p>Indicates if a script by the name name is defined.</p>
|
|
1036
|
-
</div>
|
|
1037
|
-
<div class="tsd-parameters">
|
|
1038
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1039
|
-
<ul class="tsd-parameter-list">
|
|
1040
|
-
<li>
|
|
1041
|
-
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1042
|
-
<div class="tsd-comment tsd-typography"><p>The name of the script</p>
|
|
1043
|
-
</div></li></ul></div>
|
|
1044
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
1045
|
-
<div class="tsd-comment tsd-typography">
|
|
1046
|
-
<h4>Deprecated</h4><p>Use <code>project.tasks.tryFind(name)</code></p>
|
|
1047
|
-
</div><aside class="tsd-sources">
|
|
1048
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.hasScript</p></aside></li></ul></section>
|
|
1049
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postSynthesize" class="tsd-anchor"></a>
|
|
1050
|
-
<h3 class="tsd-anchor-link"><span>post<wbr/>Synthesize</span><a href="#postSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1051
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1052
|
-
<li class="tsd-signature tsd-anchor-link" id="postSynthesize.postSynthesize-1"><span class="tsd-kind-call-signature">post<wbr/>Synthesize</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="#postSynthesize.postSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1053
|
-
<li class="tsd-description">
|
|
1054
|
-
<div class="tsd-comment tsd-typography"><p>Called after all components are synthesized. Order is <em>not</em> guaranteed.</p>
|
|
1055
|
-
</div>
|
|
1056
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1057
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1058
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postSynthesize</p></aside></li></ul></section>
|
|
1059
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="preSynthesize" class="tsd-anchor"></a>
|
|
1060
|
-
<h3 class="tsd-anchor-link"><span>pre<wbr/>Synthesize</span><a href="#preSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1061
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1062
|
-
<li class="tsd-signature tsd-anchor-link" id="preSynthesize.preSynthesize-1"><span class="tsd-kind-call-signature">pre<wbr/>Synthesize</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="#preSynthesize.preSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1063
|
-
<li class="tsd-description">
|
|
1064
|
-
<div class="tsd-comment tsd-typography"><p>Called before all components are synthesized.</p>
|
|
1065
|
-
</div>
|
|
1066
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1067
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1068
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preSynthesize</p></aside></li></ul></section>
|
|
1069
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeScript" class="tsd-anchor"></a>
|
|
1070
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Script</span><a href="#removeScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1071
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1072
|
-
<li class="tsd-signature tsd-anchor-link" id="removeScript.removeScript-1"><span class="tsd-kind-call-signature">remove<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeScript.removeScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1073
|
-
<li class="tsd-description">
|
|
1074
|
-
<div class="tsd-comment tsd-typography"><p>Removes the npm script (always successful).</p>
|
|
1075
|
-
</div>
|
|
1076
|
-
<div class="tsd-parameters">
|
|
1077
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1078
|
-
<ul class="tsd-parameter-list">
|
|
1079
|
-
<li>
|
|
1080
|
-
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1081
|
-
<div class="tsd-comment tsd-typography"><p>The name of the script.</p>
|
|
1082
|
-
</div></li></ul></div>
|
|
1083
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1084
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1085
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeScript</p></aside></li></ul></section>
|
|
1086
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeTask" class="tsd-anchor"></a>
|
|
1087
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Task</span><a href="#removeTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1088
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1089
|
-
<li class="tsd-signature tsd-anchor-link" id="removeTask.removeTask-1"><span class="tsd-kind-call-signature">remove<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span><a href="#removeTask.removeTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1090
|
-
<li class="tsd-description">
|
|
1091
|
-
<div class="tsd-comment tsd-typography"><p>Removes a task from a project.</p>
|
|
1092
|
-
</div>
|
|
1093
|
-
<div class="tsd-parameters">
|
|
1094
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1095
|
-
<ul class="tsd-parameter-list">
|
|
1096
|
-
<li>
|
|
1097
|
-
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1098
|
-
<div class="tsd-comment tsd-typography"><p>The name of the task to remove.</p>
|
|
1099
|
-
</div></li></ul></div>
|
|
1100
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span></h4><p>The <code>Task</code> that was removed, otherwise <code>undefined</code>.</p>
|
|
1101
|
-
|
|
1102
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1103
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeTask</p></aside></li></ul></section>
|
|
1104
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renderWorkflowSetup" class="tsd-anchor"></a>
|
|
1105
|
-
<h3 class="tsd-anchor-link"><span>render<wbr/>Workflow<wbr/>Setup</span><a href="#renderWorkflowSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1106
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1107
|
-
<li class="tsd-signature tsd-anchor-link" id="renderWorkflowSetup.renderWorkflowSetup-1"><span class="tsd-kind-call-signature">render<wbr/>Workflow<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</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.renderWorkflowSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1108
|
-
<li class="tsd-description">
|
|
1109
|
-
<div class="tsd-comment tsd-typography"><p>Returns the set of workflow steps which should be executed to bootstrap a
|
|
241
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">glob</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the glob pattern to match (could be a file path).</p>
|
|
242
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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>
|
|
243
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.annotateGenerated</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="hasscript" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">has<wbr/>Script</span><a href="#hasscript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="hasscript-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hasScript</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">boolean</span><a href="#hasscript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates if a script by the name name is defined.</p>
|
|
244
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the script</p>
|
|
245
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-8" class="tsd-anchor"></a>Deprecated<a href="#deprecated-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <code>project.tasks.tryFind(name)</code></p>
|
|
246
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.hasScript</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postsynthesize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>post<wbr/>Synthesize</span><a href="#postsynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="postsynthesize-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called after all components are synthesized. Order is <em>not</em> guaranteed.</p>
|
|
247
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postSynthesize</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="presynthesize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pre<wbr/>Synthesize</span><a href="#presynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="presynthesize-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called before all components are synthesized.</p>
|
|
248
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preSynthesize</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removescript" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Script</span><a href="#removescript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="removescript-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the npm script (always successful).</p>
|
|
249
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the script.</p>
|
|
250
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeScript</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removetask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Task</span><a href="#removetask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="removetask-1" class="tsd-anchor"></a><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Task</span><a href="#removetask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a task from a project.</p>
|
|
251
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the task to remove.</p>
|
|
252
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Task</span></h4><p>The <code>Task</code> that was removed, otherwise <code>undefined</code>.</p>
|
|
253
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeTask</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renderworkflowsetup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render<wbr/>Workflow<wbr/>Setup</span><a href="#renderworkflowsetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="renderworkflowsetup-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the set of workflow steps which should be executed to bootstrap a
|
|
1110
254
|
workflow.</p>
|
|
1111
|
-
</div>
|
|
1112
|
-
|
|
1113
|
-
<
|
|
1114
|
-
<ul class="tsd-parameter-list">
|
|
1115
|
-
<li>
|
|
1116
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">RenderWorkflowSetupOptions</span></h5>
|
|
1117
|
-
<div class="tsd-comment tsd-typography"><p>Options.</p>
|
|
1118
|
-
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1119
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></h4><p>Job steps</p>
|
|
1120
|
-
|
|
1121
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1122
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.renderWorkflowSetup</p></aside></li></ul></section>
|
|
1123
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runTaskCommand" class="tsd-anchor"></a>
|
|
1124
|
-
<h3 class="tsd-anchor-link"><span>run<wbr/>Task<wbr/>Command</span><a href="#runTaskCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1125
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1126
|
-
<li class="tsd-signature tsd-anchor-link" id="runTaskCommand.runTaskCommand-1"><span class="tsd-kind-call-signature">run<wbr/>Task<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#runTaskCommand.runTaskCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1127
|
-
<li class="tsd-description">
|
|
1128
|
-
<div class="tsd-comment tsd-typography"><p>Returns the shell command to execute in order to run a task. This will
|
|
255
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">RenderWorkflowSetupOptions</span></span><div class="tsd-comment tsd-typography"><p>Options.</p>
|
|
256
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></h4><p>Job steps</p>
|
|
257
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.renderWorkflowSetup</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runtaskcommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run<wbr/>Task<wbr/>Command</span><a href="#runtaskcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="runtaskcommand-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the shell command to execute in order to run a task. This will
|
|
1129
258
|
typically be <code>npx projen TASK</code>.</p>
|
|
1130
|
-
</div>
|
|
1131
|
-
<div class="tsd-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
<li>
|
|
1135
|
-
<h5><span class="tsd-kind-parameter">task</span>: <span class="tsd-signature-type ">Task</span></h5>
|
|
1136
|
-
<div class="tsd-comment tsd-typography"><p>The task for which the command is required</p>
|
|
1137
|
-
</div></li></ul></div>
|
|
1138
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
1139
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1140
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runTaskCommand</p></aside></li></ul></section>
|
|
1141
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setScript" class="tsd-anchor"></a>
|
|
1142
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Script</span><a href="#setScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1143
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1144
|
-
<li class="tsd-signature tsd-anchor-link" id="setScript.setScript-1"><span class="tsd-kind-call-signature">set<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setScript.setScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1145
|
-
<li class="tsd-description">
|
|
1146
|
-
<div class="tsd-comment tsd-typography"><p>Replaces the contents of an npm package.json script.</p>
|
|
1147
|
-
</div>
|
|
1148
|
-
<div class="tsd-parameters">
|
|
1149
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1150
|
-
<ul class="tsd-parameter-list">
|
|
1151
|
-
<li>
|
|
1152
|
-
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1153
|
-
<div class="tsd-comment tsd-typography"><p>The script name</p>
|
|
1154
|
-
</div></li>
|
|
1155
|
-
<li>
|
|
1156
|
-
<h5><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1157
|
-
<div class="tsd-comment tsd-typography"><p>The command to execute</p>
|
|
1158
|
-
</div></li></ul></div>
|
|
1159
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1160
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1161
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.setScript</p></aside></li></ul></section>
|
|
1162
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="synth" class="tsd-anchor"></a>
|
|
1163
|
-
<h3 class="tsd-anchor-link"><span>synth</span><a href="#synth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1164
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1165
|
-
<li class="tsd-signature tsd-anchor-link" id="synth.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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#synth.synth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1166
|
-
<li class="tsd-description">
|
|
1167
|
-
<div class="tsd-comment tsd-typography"><p>Synthesize all project files into <code>outdir</code>.</p>
|
|
259
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">task</span>: <span class="tsd-signature-type">Task</span></span><div class="tsd-comment tsd-typography"><p>The task for which the command is required</p>
|
|
260
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runTaskCommand</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setscript" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Script</span><a href="#setscript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="setscript-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Replaces the contents of an npm package.json script.</p>
|
|
261
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The script name</p>
|
|
262
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The command to execute</p>
|
|
263
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.setScript</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="synth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>synth</span><a href="#synth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="synth-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Synthesize all project files into <code>outdir</code>.</p>
|
|
1168
264
|
<ol>
|
|
1169
265
|
<li>Call "this.preSynthesize()"</li>
|
|
1170
266
|
<li>Delete all generated files</li>
|
|
@@ -1173,103 +269,24 @@ typically be <code>npx projen TASK</code>.</p>
|
|
|
1173
269
|
<li>Call "postSynthesize()" for all components of this project</li>
|
|
1174
270
|
<li>Call "this.postSynthesize()"</li>
|
|
1175
271
|
</ol>
|
|
1176
|
-
</div>
|
|
1177
|
-
|
|
1178
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1179
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.synth</p></aside></li></ul></section>
|
|
1180
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString" class="tsd-anchor"></a>
|
|
1181
|
-
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1182
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1183
|
-
<li class="tsd-signature tsd-anchor-link" id="toString.toString-1"><span class="tsd-kind-call-signature">to<wbr/>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">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1184
|
-
<li class="tsd-description">
|
|
1185
|
-
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
1186
|
-
</div>
|
|
1187
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
1188
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1189
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.toString</p></aside></li></ul></section>
|
|
1190
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindFile" class="tsd-anchor"></a>
|
|
1191
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>File</span><a href="#tryFindFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1192
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1193
|
-
<li class="tsd-signature tsd-anchor-link" id="tryFindFile.tryFindFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span><a href="#tryFindFile.tryFindFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1194
|
-
<li class="tsd-description">
|
|
1195
|
-
<div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and all
|
|
272
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.synth</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tostring" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="tostring-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
273
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.toString</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryfindfile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>File</span><a href="#tryfindfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="tryfindfile-1" class="tsd-anchor"></a><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">FileBase</span><a href="#tryfindfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and all
|
|
1196
274
|
its subprojects.</p>
|
|
1197
|
-
</div>
|
|
1198
|
-
<div class="tsd-parameters">
|
|
1199
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1200
|
-
<ul class="tsd-parameter-list">
|
|
1201
|
-
<li>
|
|
1202
|
-
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1203
|
-
<div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be resolved
|
|
275
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be resolved
|
|
1204
276
|
from the root of <em>this</em> project.</p>
|
|
1205
|
-
</div></li></ul></div>
|
|
1206
|
-
<
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>
|
|
1212
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1213
|
-
<li class="tsd-signature tsd-anchor-link" id="tryFindJsonFile.tryFindJsonFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>Json<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">JsonFile</span><a href="#tryFindJsonFile.tryFindJsonFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1214
|
-
<li class="tsd-description">
|
|
1215
|
-
<div class="tsd-comment tsd-typography"><p>Finds a json file by name.</p>
|
|
1216
|
-
</div>
|
|
1217
|
-
<div class="tsd-parameters">
|
|
1218
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1219
|
-
<ul class="tsd-parameter-list">
|
|
1220
|
-
<li>
|
|
1221
|
-
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1222
|
-
<div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
1223
|
-
</div></li></ul></div>
|
|
1224
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">JsonFile</span></h4>
|
|
1225
|
-
<div class="tsd-comment tsd-typography">
|
|
1226
|
-
<h4>Deprecated</h4><p>use <code>tryFindObjectFile</code></p>
|
|
1227
|
-
</div><aside class="tsd-sources">
|
|
1228
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindJsonFile</p></aside></li></ul></section>
|
|
1229
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindObjectFile" class="tsd-anchor"></a>
|
|
1230
|
-
<h3 class="tsd-anchor-link"><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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1231
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1232
|
-
<li class="tsd-signature tsd-anchor-link" id="tryFindObjectFile.tryFindObjectFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>Object<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ObjectFile</span><a href="#tryFindObjectFile.tryFindObjectFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1233
|
-
<li class="tsd-description">
|
|
1234
|
-
<div class="tsd-comment tsd-typography"><p>Finds an object file (like JsonFile, YamlFile, etc.) by name.</p>
|
|
1235
|
-
</div>
|
|
1236
|
-
<div class="tsd-parameters">
|
|
1237
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1238
|
-
<ul class="tsd-parameter-list">
|
|
1239
|
-
<li>
|
|
1240
|
-
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1241
|
-
<div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
1242
|
-
</div></li></ul></div>
|
|
1243
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ObjectFile</span></h4>
|
|
1244
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1245
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindObjectFile</p></aside></li></ul></section>
|
|
1246
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryRemoveFile" class="tsd-anchor"></a>
|
|
1247
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>Remove<wbr/>File</span><a href="#tryRemoveFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1248
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1249
|
-
<li class="tsd-signature tsd-anchor-link" id="tryRemoveFile.tryRemoveFile-1"><span class="tsd-kind-call-signature">try<wbr/>Remove<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span><a href="#tryRemoveFile.tryRemoveFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1250
|
-
<li class="tsd-description">
|
|
1251
|
-
<div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and removes
|
|
277
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">FileBase</span></h4><p>a <code>FileBase</code> or undefined if there is no file in that path</p>
|
|
278
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindFile</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryfindjsonfile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">try<wbr/>Find<wbr/>Json<wbr/>File</span><a href="#tryfindjsonfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="tryfindjsonfile-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">tryFindJsonFile</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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">JsonFile</span><a href="#tryfindjsonfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a json file by name.</p>
|
|
279
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
280
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">JsonFile</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-9" class="tsd-anchor"></a>Deprecated<a href="#deprecated-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <code>tryFindObjectFile</code></p>
|
|
281
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindJsonFile</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryfindobjectfile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="tryfindobjectfile-1" class="tsd-anchor"></a><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ObjectFile</span><a href="#tryfindobjectfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds an object file (like JsonFile, YamlFile, etc.) by name.</p>
|
|
282
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
283
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">ObjectFile</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindObjectFile</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryremovefile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Remove<wbr/>File</span><a href="#tryremovefile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="tryremovefile-1" class="tsd-anchor"></a><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">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">FileBase</span><a href="#tryremovefile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and removes
|
|
1252
284
|
it.</p>
|
|
1253
|
-
</div>
|
|
1254
|
-
<div class="tsd-parameters">
|
|
1255
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1256
|
-
<ul class="tsd-parameter-list">
|
|
1257
|
-
<li>
|
|
1258
|
-
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1259
|
-
<div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be
|
|
285
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be
|
|
1260
286
|
resolved from the root of <em>this</em> project.</p>
|
|
1261
|
-
</div></li></ul></div>
|
|
1262
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><p>a <code>FileBase</code> if the file was found and removed, or undefined if
|
|
287
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">FileBase</span></h4><p>a <code>FileBase</code> if the file was found and removed, or undefined if
|
|
1263
288
|
the file was not found.</p>
|
|
1264
|
-
|
|
1265
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1266
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></li></ul></section>
|
|
1267
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
1268
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1269
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1270
|
-
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1271
|
-
<li class="tsd-description">
|
|
1272
|
-
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
289
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isconstruct" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="isconstruct-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
1273
290
|
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
1274
291
|
instances, even when the construct library is symlinked.</p>
|
|
1275
292
|
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
@@ -1282,191 +299,10 @@ use a monorepo tool: in those cases, multiple copies of the <code>constructs</co
|
|
|
1282
299
|
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
1283
300
|
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
1284
301
|
this type-testing method instead.</p>
|
|
1285
|
-
</div>
|
|
1286
|
-
|
|
1287
|
-
<
|
|
1288
|
-
|
|
1289
|
-
<li>
|
|
1290
|
-
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
1291
|
-
<div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
1292
|
-
</div></li></ul></div>
|
|
1293
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> 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>
|
|
1294
|
-
|
|
1295
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1296
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isConstruct</p></aside></li></ul></section>
|
|
1297
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isProject" class="tsd-anchor"></a>
|
|
1298
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Project</span><a href="#isProject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1299
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1300
|
-
<li class="tsd-signature tsd-anchor-link" id="isProject.isProject-1"><span class="tsd-kind-call-signature">is<wbr/>Project</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Project</span><a href="#isProject.isProject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1301
|
-
<li class="tsd-description">
|
|
1302
|
-
<div class="tsd-comment tsd-typography"><p>Test whether the given construct is a project.</p>
|
|
1303
|
-
</div>
|
|
1304
|
-
<div class="tsd-parameters">
|
|
1305
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1306
|
-
<ul class="tsd-parameter-list">
|
|
1307
|
-
<li>
|
|
1308
|
-
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1309
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Project</span></h4>
|
|
1310
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1311
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isProject</p></aside></li></ul></section>
|
|
1312
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="of" class="tsd-anchor"></a>
|
|
1313
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>of</span><a href="#of" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1314
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1315
|
-
<li class="tsd-signature tsd-anchor-link" id="of.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-symbol">: </span><span class="tsd-signature-type ">Project</span><a href="#of.of-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1316
|
-
<li class="tsd-description">
|
|
1317
|
-
<div class="tsd-comment tsd-typography"><p>Find the closest ancestor project for given construct.
|
|
302
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
303
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><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>
|
|
304
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isConstruct</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isproject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="isproject-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Test whether the given construct is a project.</p>
|
|
305
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isProject</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="of" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="of-1" class="tsd-anchor"></a><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Find the closest ancestor project for given construct.
|
|
1318
306
|
When given a project, this it the project itself.</p>
|
|
1319
|
-
</div>
|
|
1320
|
-
<div class="tsd-parameters">
|
|
1321
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1322
|
-
<ul class="tsd-parameter-list">
|
|
1323
|
-
<li>
|
|
1324
|
-
<h5><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type ">IConstruct</span></h5></li></ul></div>
|
|
1325
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Project</span></h4>
|
|
1326
|
-
<div class="tsd-comment tsd-typography">
|
|
1327
|
-
<h4>Throws</h4><p>when no project is found in the path to the root</p>
|
|
1328
|
-
</div><aside class="tsd-sources">
|
|
1329
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.of</p></aside></li></ul></section></section></div>
|
|
1330
|
-
<div class="col-sidebar">
|
|
1331
|
-
<div class="page-menu">
|
|
1332
|
-
<div class="tsd-navigation settings">
|
|
1333
|
-
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1334
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
1335
|
-
<div class="tsd-accordion-details">
|
|
1336
|
-
<div class="tsd-filter-visibility">
|
|
1337
|
-
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1338
|
-
<ul id="tsd-filter-options">
|
|
1339
|
-
<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>
|
|
1340
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
1341
|
-
<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>
|
|
1342
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
1343
|
-
<div class="tsd-theme-toggle">
|
|
1344
|
-
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1345
|
-
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1346
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1347
|
-
<div class="tsd-accordion-details">
|
|
1348
|
-
<ul>
|
|
1349
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
|
1350
|
-
<li><a href="#appEntrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a></li>
|
|
1351
|
-
<li><a href="#artifactsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a></li>
|
|
1352
|
-
<li><a href="#artifactsJavascriptDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a></li>
|
|
1353
|
-
<li><a href="#autoApprove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Approve</span></a></li>
|
|
1354
|
-
<li><a href="#autoMerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a></li>
|
|
1355
|
-
<li><a href="#buildWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a></li>
|
|
1356
|
-
<li><a href="#bundler" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bundler</span></a></li>
|
|
1357
|
-
<li><a href="#cdkConfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Config</span></a></li>
|
|
1358
|
-
<li><a href="#cdkDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Deps</span></a></li>
|
|
1359
|
-
<li><a href="#cdkTasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Tasks</span></a></li>
|
|
1360
|
-
<li><a href="#commitGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a></li>
|
|
1361
|
-
<li><a href="#defaultTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Task</span></a></li>
|
|
1362
|
-
<li><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>deps</span></a></li>
|
|
1363
|
-
<li><a href="#devContainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dev<wbr/>Container</span></a></li>
|
|
1364
|
-
<li><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>docgen</span></a></li>
|
|
1365
|
-
<li><a href="#docsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a></li>
|
|
1366
|
-
<li><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>eslint</span></a></li>
|
|
1367
|
-
<li><a href="#gitattributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitattributes</span></a></li>
|
|
1368
|
-
<li><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>github</span></a></li>
|
|
1369
|
-
<li><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitignore</span></a></li>
|
|
1370
|
-
<li><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitpod</span></a></li>
|
|
1371
|
-
<li><a href="#initProject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>init<wbr/>Project</span></a></li>
|
|
1372
|
-
<li><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>jest</span></a></li>
|
|
1373
|
-
<li><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>libdir</span></a></li>
|
|
1374
|
-
<li><a href="#logger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>logger</span></a></li>
|
|
1375
|
-
<li><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>name</span></a></li>
|
|
1376
|
-
<li><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node</span></a></li>
|
|
1377
|
-
<li><a href="#nodeVersion" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node<wbr/>Version</span></a></li>
|
|
1378
|
-
<li><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npmignore</span></a></li>
|
|
1379
|
-
<li><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>outdir</span></a></li>
|
|
1380
|
-
<li><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>package</span></a></li>
|
|
1381
|
-
<li><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>parent</span></a></li>
|
|
1382
|
-
<li><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prettier</span></a></li>
|
|
1383
|
-
<li><a href="#projectBuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project<wbr/>Build</span></a></li>
|
|
1384
|
-
<li><a href="#projectType" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project<wbr/>Type</span></a></li>
|
|
1385
|
-
<li><a href="#publisher" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>publisher</span></a></li>
|
|
1386
|
-
<li><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release</span></a></li>
|
|
1387
|
-
<li><a href="#runScriptCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>run<wbr/>Script<wbr/>Command</span></a></li>
|
|
1388
|
-
<li><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>srcdir</span></a></li>
|
|
1389
|
-
<li><a href="#tasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tasks</span></a></li>
|
|
1390
|
-
<li><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>testdir</span></a></li>
|
|
1391
|
-
<li><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig</span></a></li>
|
|
1392
|
-
<li><a href="#tsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a></li>
|
|
1393
|
-
<li><a href="#tsconfigEslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig<wbr/>Eslint</span></a></li>
|
|
1394
|
-
<li><a href="#upgradeWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>upgrade<wbr/>Workflow</span></a></li>
|
|
1395
|
-
<li><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>vscode</span></a></li>
|
|
1396
|
-
<li><a href="#watchTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>watch<wbr/>Task</span></a></li>
|
|
1397
|
-
<li><a href="#workflowBootstrapSteps" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a></li>
|
|
1398
|
-
<li><a href="#workflowPackageCache" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a></li>
|
|
1399
|
-
<li><a href="#DEFAULT_TASK" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>DEFAULT_<wbr/>TASK</span></a></li>
|
|
1400
|
-
<li><a href="#DEFAULT_TS_JEST_TRANFORM_PATTERN" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span></a></li>
|
|
1401
|
-
<li><a href="#allowLibraryDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a></li>
|
|
1402
|
-
<li><a href="#buildTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>build<wbr/>Task</span></a></li>
|
|
1403
|
-
<li><a href="#buildWorkflowJobId" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span></a></li>
|
|
1404
|
-
<li><a href="#cdkVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a></li>
|
|
1405
|
-
<li><a href="#compileTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>compile<wbr/>Task</span></a></li>
|
|
1406
|
-
<li><a href="#components" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>components</span></a></li>
|
|
1407
|
-
<li><a href="#ejected" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ejected</span></a></li>
|
|
1408
|
-
<li><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>entrypoint</span></a></li>
|
|
1409
|
-
<li><a href="#files" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>files</span></a></li>
|
|
1410
|
-
<li><a href="#manifest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>manifest</span></a></li>
|
|
1411
|
-
<li><a href="#maxNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a></li>
|
|
1412
|
-
<li><a href="#minNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a></li>
|
|
1413
|
-
<li><a href="#npmrc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>npmrc</span></a></li>
|
|
1414
|
-
<li><a href="#packageManager" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>package<wbr/>Manager</span></a></li>
|
|
1415
|
-
<li><a href="#packageTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>package<wbr/>Task</span></a></li>
|
|
1416
|
-
<li><a href="#postCompileTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>post<wbr/>Compile<wbr/>Task</span></a></li>
|
|
1417
|
-
<li><a href="#preCompileTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>pre<wbr/>Compile<wbr/>Task</span></a></li>
|
|
1418
|
-
<li><a href="#projenCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>projen<wbr/>Command</span></a></li>
|
|
1419
|
-
<li><a href="#root" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>root</span></a></li>
|
|
1420
|
-
<li><a href="#subprojects" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>subprojects</span></a></li>
|
|
1421
|
-
<li><a href="#testTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>test<wbr/>Task</span></a></li>
|
|
1422
|
-
<li><a href="#addBins" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Bins</span></a></li>
|
|
1423
|
-
<li><a href="#addBundledDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a></li>
|
|
1424
|
-
<li><a href="#addCdkDependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Cdk<wbr/>Dependency</span></a></li>
|
|
1425
|
-
<li><a href="#addCompileCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Compile<wbr/>Command</span></a></li>
|
|
1426
|
-
<li><a href="#addDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Deps</span></a></li>
|
|
1427
|
-
<li><a href="#addDevDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a></li>
|
|
1428
|
-
<li><a href="#addExcludeFromCleanup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a></li>
|
|
1429
|
-
<li><a href="#addFields" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Fields</span></a></li>
|
|
1430
|
-
<li><a href="#addGitIgnore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Git<wbr/>Ignore</span></a></li>
|
|
1431
|
-
<li><a href="#addKeywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Keywords</span></a></li>
|
|
1432
|
-
<li><a href="#addPackageIgnore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Package<wbr/>Ignore</span></a></li>
|
|
1433
|
-
<li><a href="#addPeerDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a></li>
|
|
1434
|
-
<li><a href="#addScripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a></li>
|
|
1435
|
-
<li><a href="#addTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task</span></a></li>
|
|
1436
|
-
<li><a href="#addTestCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a></li>
|
|
1437
|
-
<li><a href="#addTip" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Tip</span></a></li>
|
|
1438
|
-
<li><a href="#annotateGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a></li>
|
|
1439
|
-
<li><a href="#hasScript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Script</span></a></li>
|
|
1440
|
-
<li><a href="#postSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a></li>
|
|
1441
|
-
<li><a href="#preSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a></li>
|
|
1442
|
-
<li><a href="#removeScript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Script</span></a></li>
|
|
1443
|
-
<li><a href="#removeTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task</span></a></li>
|
|
1444
|
-
<li><a href="#renderWorkflowSetup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a></li>
|
|
1445
|
-
<li><a href="#runTaskCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Task<wbr/>Command</span></a></li>
|
|
1446
|
-
<li><a href="#setScript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Script</span></a></li>
|
|
1447
|
-
<li><a href="#synth" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synth</span></a></li>
|
|
1448
|
-
<li><a href="#toString" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a></li>
|
|
1449
|
-
<li><a href="#tryFindFile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>File</span></a></li>
|
|
1450
|
-
<li><a href="#tryFindJsonFile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Json<wbr/>File</span></a></li>
|
|
1451
|
-
<li><a href="#tryFindObjectFile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Find<wbr/>Object<wbr/>File</span></a></li>
|
|
1452
|
-
<li><a href="#tryRemoveFile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a></li>
|
|
1453
|
-
<li><a href="#isConstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Construct</span></a></li>
|
|
1454
|
-
<li><a href="#isProject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Project</span></a></li>
|
|
1455
|
-
<li><a href="#of" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>of</span></a></li></ul></div></details></div>
|
|
1456
|
-
<div class="site-menu">
|
|
1457
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
1458
|
-
<ul class="tsd-small-nested-navigation">
|
|
1459
|
-
<li><a href="Datastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Datastore</span></a></li>
|
|
1460
|
-
<li><a href="GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
1461
|
-
<li><a href="RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
1462
|
-
<li><a href="ServerlessProject.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
1463
|
-
<li><a href="Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
1464
|
-
<li><a href="../interfaces/DatastoreOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Datastore<wbr/>Options</span></a></li>
|
|
1465
|
-
<li><a href="../interfaces/GraphQlApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Options</span></a></li>
|
|
1466
|
-
<li><a href="../interfaces/RestApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Options</span></a></li>
|
|
1467
|
-
<li><a href="../interfaces/ServerlessProjectOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Serverless<wbr/>Project<wbr/>Options</span></a></li>
|
|
1468
|
-
<li><a href="../interfaces/WorkflowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Options</span></a></li>
|
|
1469
|
-
<li><a href="../variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>PACKAGE_<wbr/>NAME</span></a></li></ul></nav></div></div></div>
|
|
1470
|
-
<div class="tsd-generator">
|
|
1471
|
-
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
|
|
1472
|
-
<div class="overlay"></div></body></html>
|
|
307
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type">IConstruct</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Project</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>when no project is found in the path to the root</p>
|
|
308
|
+
</div></div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.of</p></aside></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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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"><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"><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"><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"><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"><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"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#buildworkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><use href="../assets/icons.svg#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a><a href="#hasscript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Remove<wbr/>File</span></a><a href="#isconstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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"><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"><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>
|