cdk-serverless 2.8.0 → 2.9.1
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/.gitattributes +0 -1
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/classes/Datastore.html +73 -3
- package/docs/projen/classes/GraphQlApi.html +72 -2
- package/docs/projen/classes/RestApi.html +90 -3
- package/docs/projen/classes/ServerlessProject.html +124 -22
- package/docs/projen/classes/Workflow.html +73 -3
- package/docs/projen/interfaces/ServerlessProjectOptions.html +67 -4
- package/lib/projen/graphql.js +18 -18
- package/lib/projen/rest-api.d.ts +1 -0
- package/lib/projen/rest-api.js +34 -1
- package/package.json +26 -26
|
@@ -58,9 +58,9 @@
|
|
|
58
58
|
<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="#icon-1024"></use></svg><span>libdir</span></a>
|
|
59
59
|
<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="#icon-1024"></use></svg><span>logger</span></a>
|
|
60
60
|
<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="#icon-1024"></use></svg><span>name</span></a>
|
|
61
|
+
<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="#icon-1024"></use></svg><span>node</span></a>
|
|
61
62
|
<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="#icon-1024"></use></svg><span>node<wbr/>Version?</span></a>
|
|
62
63
|
<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="#icon-1024"></use></svg><span>npmignore?</span></a>
|
|
63
|
-
<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="#icon-1024"></use></svg><span>npmrc</span></a>
|
|
64
64
|
<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="#icon-1024"></use></svg><span>outdir</span></a>
|
|
65
65
|
<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="#icon-1024"></use></svg><span>package</span></a>
|
|
66
66
|
<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="#icon-1024"></use></svg><span>parent?</span></a>
|
|
@@ -70,7 +70,6 @@
|
|
|
70
70
|
<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="#icon-1024"></use></svg><span>projen<wbr/>Command</span></a>
|
|
71
71
|
<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="#icon-1024"></use></svg><span>publisher?</span></a>
|
|
72
72
|
<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="#icon-1024"></use></svg><span>release?</span></a>
|
|
73
|
-
<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="#icon-1024"></use></svg><span>root</span></a>
|
|
74
73
|
<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="#icon-1024"></use></svg><span>run<wbr/>Script<wbr/>Command</span></a>
|
|
75
74
|
<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="#icon-1024"></use></svg><span>srcdir</span></a>
|
|
76
75
|
<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="#icon-1024"></use></svg><span>tasks</span></a>
|
|
@@ -84,6 +83,7 @@
|
|
|
84
83
|
<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="#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a>
|
|
85
84
|
<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="#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a>
|
|
86
85
|
<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="#icon-1024"></use></svg><span>DEFAULT_<wbr/>TASK</span></a>
|
|
86
|
+
<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="#icon-1024"></use></svg><span>DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span></a>
|
|
87
87
|
</div></section>
|
|
88
88
|
<section class="tsd-index-section">
|
|
89
89
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
@@ -99,10 +99,12 @@
|
|
|
99
99
|
<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="#icon-262144"></use></svg><span>manifest</span></a>
|
|
100
100
|
<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="#icon-262144"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a>
|
|
101
101
|
<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="#icon-262144"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a>
|
|
102
|
+
<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="#icon-262144"></use></svg><span>npmrc</span></a>
|
|
102
103
|
<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="#icon-262144"></use></svg><span>package<wbr/>Manager</span></a>
|
|
103
104
|
<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="#icon-262144"></use></svg><span>package<wbr/>Task</span></a>
|
|
104
105
|
<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="#icon-262144"></use></svg><span>post<wbr/>Compile<wbr/>Task</span></a>
|
|
105
106
|
<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="#icon-262144"></use></svg><span>pre<wbr/>Compile<wbr/>Task</span></a>
|
|
107
|
+
<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="#icon-262144"></use></svg><span>root</span></a>
|
|
106
108
|
<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="#icon-262144"></use></svg><span>subprojects</span></a>
|
|
107
109
|
<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="#icon-262144"></use></svg><span>test<wbr/>Task</span></a>
|
|
108
110
|
</div></section>
|
|
@@ -134,10 +136,14 @@
|
|
|
134
136
|
<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>
|
|
135
137
|
<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>
|
|
136
138
|
<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>
|
|
139
|
+
<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>
|
|
137
140
|
<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>
|
|
138
141
|
<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>
|
|
139
142
|
<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>
|
|
140
143
|
<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>
|
|
144
|
+
<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>
|
|
145
|
+
<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>
|
|
146
|
+
<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>
|
|
141
147
|
</div></section></div></details></section></section>
|
|
142
148
|
<section class="tsd-panel-group tsd-member-group">
|
|
143
149
|
<h2>Constructors</h2>
|
|
@@ -330,6 +336,13 @@ FQN of the project type.</p>
|
|
|
330
336
|
</div>
|
|
331
337
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
332
338
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.name</p></aside></section>
|
|
339
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
340
|
+
<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>
|
|
341
|
+
<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>
|
|
342
|
+
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
343
|
+
</div>
|
|
344
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
345
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.node</p></aside></section>
|
|
333
346
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="nodeVersion" class="tsd-anchor"></a>
|
|
334
347
|
<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>
|
|
335
348
|
<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">
|
|
@@ -341,13 +354,6 @@ FQN of the project type.</p>
|
|
|
341
354
|
</div>
|
|
342
355
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
343
356
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmignore</p></aside></section>
|
|
344
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmrc" class="tsd-anchor"></a>
|
|
345
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
346
|
-
<div class="tsd-signature"><span class="tsd-kind-property">npmrc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">NpmConfig</span></div>
|
|
347
|
-
<div class="tsd-comment tsd-typography"><p>The .npmrc file</p>
|
|
348
|
-
</div>
|
|
349
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
350
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmrc</p></aside></section>
|
|
351
357
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
352
358
|
<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>
|
|
353
359
|
<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>
|
|
@@ -408,13 +414,6 @@ release workflow.</p>
|
|
|
408
414
|
</div>
|
|
409
415
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
410
416
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.release</p></aside></section>
|
|
411
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="root" class="tsd-anchor"></a>
|
|
412
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
413
|
-
<div class="tsd-signature"><span class="tsd-kind-property">root</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Project</span></div>
|
|
414
|
-
<div class="tsd-comment tsd-typography"><p>The root project.</p>
|
|
415
|
-
</div>
|
|
416
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
417
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.root</p></aside></section>
|
|
418
417
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runScriptCommand" class="tsd-anchor"></a>
|
|
419
418
|
<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>
|
|
420
419
|
<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>
|
|
@@ -495,7 +494,11 @@ release workflow.</p>
|
|
|
495
494
|
this task should synthesize the project files.</p>
|
|
496
495
|
</div>
|
|
497
496
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
498
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TASK</p></aside></section
|
|
497
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TASK</p></aside></section>
|
|
498
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="DEFAULT_TS_JEST_TRANFORM_PATTERN" class="tsd-anchor"></a>
|
|
499
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">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="#icon-anchor"></use></svg></a></h3>
|
|
500
|
+
<div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>TS_<wbr/>JEST_<wbr/>TRANFORM_<wbr/>PATTERN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"^.+\\.[t]sx?$"</span><span class="tsd-signature-symbol"> = "^.+\\.[t]sx?$"</span></div><aside class="tsd-sources">
|
|
501
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TS_JEST_TRANFORM_PATTERN</p></aside></section></section>
|
|
499
502
|
<section class="tsd-panel-group tsd-member-group">
|
|
500
503
|
<h2>Accessors</h2>
|
|
501
504
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowLibraryDependencies" class="tsd-anchor"></a>
|
|
@@ -612,6 +615,16 @@ this task should synthesize the project files.</p>
|
|
|
612
615
|
<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
616
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
614
617
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.minNodeVersion</p></aside></li></ul></section>
|
|
618
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmrc" class="tsd-anchor"></a>
|
|
619
|
+
<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>
|
|
620
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
621
|
+
<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>
|
|
622
|
+
<li class="tsd-description">
|
|
623
|
+
<div class="tsd-comment tsd-typography"><p>The .npmrc file</p>
|
|
624
|
+
</div>
|
|
625
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">NpmConfig</span></h4>
|
|
626
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
627
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.npmrc</p></aside></li></ul></section>
|
|
615
628
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
616
629
|
<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>
|
|
617
630
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -645,6 +658,16 @@ this task should synthesize the project files.</p>
|
|
|
645
658
|
<li class="tsd-description">
|
|
646
659
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
647
660
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preCompileTask</p></aside></li></ul></section>
|
|
661
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="root" class="tsd-anchor"></a>
|
|
662
|
+
<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>
|
|
663
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
664
|
+
<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>
|
|
665
|
+
<li class="tsd-description">
|
|
666
|
+
<div class="tsd-comment tsd-typography"><p>The root project.</p>
|
|
667
|
+
</div>
|
|
668
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Project</span></h4>
|
|
669
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
670
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.root</p></aside></li></ul></section>
|
|
648
671
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="subprojects" class="tsd-anchor"></a>
|
|
649
672
|
<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>
|
|
650
673
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -1121,7 +1144,7 @@ typically be <code>npx projen TASK</code>.</p>
|
|
|
1121
1144
|
<ol>
|
|
1122
1145
|
<li>Call "this.preSynthesize()"</li>
|
|
1123
1146
|
<li>Delete all generated files</li>
|
|
1124
|
-
<li>Synthesize all
|
|
1147
|
+
<li>Synthesize all subprojects</li>
|
|
1125
1148
|
<li>Synthesize all components of this project</li>
|
|
1126
1149
|
<li>Call "postSynthesize()" for all components of this project</li>
|
|
1127
1150
|
<li>Call "this.postSynthesize()"</li>
|
|
@@ -1130,6 +1153,16 @@ typically be <code>npx projen TASK</code>.</p>
|
|
|
1130
1153
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1131
1154
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1132
1155
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.synth</p></aside></li></ul></section>
|
|
1156
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString" class="tsd-anchor"></a>
|
|
1157
|
+
<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>
|
|
1158
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1159
|
+
<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>
|
|
1160
|
+
<li class="tsd-description">
|
|
1161
|
+
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
1162
|
+
</div>
|
|
1163
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
1164
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1165
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.toString</p></aside></li></ul></section>
|
|
1133
1166
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindFile" class="tsd-anchor"></a>
|
|
1134
1167
|
<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>
|
|
1135
1168
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
@@ -1206,7 +1239,70 @@ resolved from the root of <em>this</em> project.</p>
|
|
|
1206
1239
|
the file was not found.</p>
|
|
1207
1240
|
|
|
1208
1241
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1209
|
-
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></li></ul></section
|
|
1242
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></li></ul></section>
|
|
1243
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
1244
|
+
<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>
|
|
1245
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1246
|
+
<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>
|
|
1247
|
+
<li class="tsd-description">
|
|
1248
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
1249
|
+
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
1250
|
+
instances, even when the construct library is symlinked.</p>
|
|
1251
|
+
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
1252
|
+
disk are seen as independent, completely different libraries. As a
|
|
1253
|
+
consequence, the class <code>Construct</code> in each copy of the <code>constructs</code> library
|
|
1254
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1255
|
+
<code>instanceof</code> the other class. <code>npm install</code> will not create installations
|
|
1256
|
+
like this, but users may manually symlink construct libraries together or
|
|
1257
|
+
use a monorepo tool: in those cases, multiple copies of the <code>constructs</code>
|
|
1258
|
+
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
1259
|
+
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
1260
|
+
this type-testing method instead.</p>
|
|
1261
|
+
</div>
|
|
1262
|
+
<div class="tsd-parameters">
|
|
1263
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1264
|
+
<ul class="tsd-parameter-list">
|
|
1265
|
+
<li>
|
|
1266
|
+
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
1267
|
+
<div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
1268
|
+
</div></li></ul></div>
|
|
1269
|
+
<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>
|
|
1270
|
+
|
|
1271
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1272
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isConstruct</p></aside></li></ul></section>
|
|
1273
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isProject" class="tsd-anchor"></a>
|
|
1274
|
+
<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>
|
|
1275
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1276
|
+
<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>
|
|
1277
|
+
<li class="tsd-description">
|
|
1278
|
+
<div class="tsd-comment tsd-typography"><p>Test whether the given construct is a project.</p>
|
|
1279
|
+
</div>
|
|
1280
|
+
<div class="tsd-parameters">
|
|
1281
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1282
|
+
<ul class="tsd-parameter-list">
|
|
1283
|
+
<li>
|
|
1284
|
+
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
1285
|
+
<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>
|
|
1286
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1287
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.isProject</p></aside></li></ul></section>
|
|
1288
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="of" class="tsd-anchor"></a>
|
|
1289
|
+
<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>
|
|
1290
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1291
|
+
<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>
|
|
1292
|
+
<li class="tsd-description">
|
|
1293
|
+
<div class="tsd-comment tsd-typography"><p>Find the closest ancestor project for given construct.
|
|
1294
|
+
When given a project, this it the project itself.</p>
|
|
1295
|
+
</div>
|
|
1296
|
+
<div class="tsd-parameters">
|
|
1297
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1298
|
+
<ul class="tsd-parameter-list">
|
|
1299
|
+
<li>
|
|
1300
|
+
<h5><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type ">IConstruct</span></h5></li></ul></div>
|
|
1301
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Project</span></h4>
|
|
1302
|
+
<div class="tsd-comment tsd-typography">
|
|
1303
|
+
<h4>Throws</h4><p>when no project is found in the path to the root</p>
|
|
1304
|
+
</div><aside class="tsd-sources">
|
|
1305
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.of</p></aside></li></ul></section></section></div>
|
|
1210
1306
|
<div class="col-sidebar">
|
|
1211
1307
|
<div class="page-menu">
|
|
1212
1308
|
<div class="tsd-navigation settings">
|
|
@@ -1253,9 +1349,9 @@ the file was not found.</p>
|
|
|
1253
1349
|
<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>
|
|
1254
1350
|
<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>
|
|
1255
1351
|
<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>
|
|
1352
|
+
<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>
|
|
1256
1353
|
<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>
|
|
1257
1354
|
<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>
|
|
1258
|
-
<li><a href="#npmrc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npmrc</span></a></li>
|
|
1259
1355
|
<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>
|
|
1260
1356
|
<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>
|
|
1261
1357
|
<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>
|
|
@@ -1265,7 +1361,6 @@ the file was not found.</p>
|
|
|
1265
1361
|
<li><a href="#projenCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projen<wbr/>Command</span></a></li>
|
|
1266
1362
|
<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>
|
|
1267
1363
|
<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>
|
|
1268
|
-
<li><a href="#root" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>root</span></a></li>
|
|
1269
1364
|
<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>
|
|
1270
1365
|
<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>
|
|
1271
1366
|
<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>
|
|
@@ -1279,6 +1374,7 @@ the file was not found.</p>
|
|
|
1279
1374
|
<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>
|
|
1280
1375
|
<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>
|
|
1281
1376
|
<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>
|
|
1377
|
+
<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>
|
|
1282
1378
|
<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>
|
|
1283
1379
|
<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>
|
|
1284
1380
|
<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>
|
|
@@ -1291,10 +1387,12 @@ the file was not found.</p>
|
|
|
1291
1387
|
<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>
|
|
1292
1388
|
<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>
|
|
1293
1389
|
<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>
|
|
1390
|
+
<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>
|
|
1294
1391
|
<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>
|
|
1295
1392
|
<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>
|
|
1296
1393
|
<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>
|
|
1297
1394
|
<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>
|
|
1395
|
+
<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>
|
|
1298
1396
|
<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>
|
|
1299
1397
|
<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>
|
|
1300
1398
|
<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>
|
|
@@ -1323,10 +1421,14 @@ the file was not found.</p>
|
|
|
1323
1421
|
<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>
|
|
1324
1422
|
<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>
|
|
1325
1423
|
<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>
|
|
1424
|
+
<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>
|
|
1326
1425
|
<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>
|
|
1327
1426
|
<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>
|
|
1328
1427
|
<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>
|
|
1329
|
-
<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
|
|
1428
|
+
<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>
|
|
1429
|
+
<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>
|
|
1430
|
+
<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>
|
|
1431
|
+
<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>
|
|
1330
1432
|
<div class="site-menu">
|
|
1331
1433
|
<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>
|
|
1332
1434
|
<ul class="tsd-small-nested-navigation">
|
|
@@ -32,7 +32,8 @@
|
|
|
32
32
|
</div></section>
|
|
33
33
|
<section class="tsd-index-section">
|
|
34
34
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
35
|
-
<div class="tsd-index-list"><a href="Workflow.html#
|
|
35
|
+
<div class="tsd-index-list"><a href="Workflow.html#node" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>node</span></a>
|
|
36
|
+
<a href="Workflow.html#options" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>options</span></a>
|
|
36
37
|
<a href="Workflow.html#project" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project</span></a>
|
|
37
38
|
</div></section>
|
|
38
39
|
<section class="tsd-index-section">
|
|
@@ -43,6 +44,9 @@
|
|
|
43
44
|
<a href="Workflow.html#renderDefinitionSubstitution" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Definition<wbr/>Substitution</span></a>
|
|
44
45
|
<a href="Workflow.html#renderStateConfigDefinition" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span></a>
|
|
45
46
|
<a href="Workflow.html#synthesize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synthesize</span></a>
|
|
47
|
+
<a href="Workflow.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>
|
|
48
|
+
<a href="Workflow.html#isComponent" 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/>Component</span></a>
|
|
49
|
+
<a href="Workflow.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>
|
|
46
50
|
</div></section></div></details></section></section>
|
|
47
51
|
<section class="tsd-panel-group tsd-member-group">
|
|
48
52
|
<h2>Constructors</h2>
|
|
@@ -62,6 +66,13 @@
|
|
|
62
66
|
<p>Overrides pj.Component.constructor</p></aside></li></ul></section></section>
|
|
63
67
|
<section class="tsd-panel-group tsd-member-group">
|
|
64
68
|
<h2>Properties</h2>
|
|
69
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
70
|
+
<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>
|
|
71
|
+
<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>
|
|
72
|
+
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
73
|
+
</div>
|
|
74
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
75
|
+
<p>Inherited from pj.Component.node</p></aside></section>
|
|
65
76
|
<section class="tsd-panel tsd-member tsd-is-protected"><a id="options" class="tsd-anchor"></a>
|
|
66
77
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
67
78
|
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkflowOptions.html" class="tsd-signature-type tsd-kind-interface">WorkflowOptions</a></div></section>
|
|
@@ -132,7 +143,62 @@
|
|
|
132
143
|
<li class="tsd-signature tsd-anchor-link" id="synthesize.synthesize-1"><span class="tsd-kind-call-signature">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="#synthesize.synthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
133
144
|
<li class="tsd-description">
|
|
134
145
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
135
|
-
<p>Overrides pj.Component.synthesize</p></aside></li></ul></section
|
|
146
|
+
<p>Overrides pj.Component.synthesize</p></aside></li></ul></section>
|
|
147
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString" class="tsd-anchor"></a>
|
|
148
|
+
<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>
|
|
149
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
150
|
+
<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>
|
|
151
|
+
<li class="tsd-description">
|
|
152
|
+
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
153
|
+
</div>
|
|
154
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
155
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
156
|
+
<p>Inherited from pj.Component.toString</p></aside></li></ul></section>
|
|
157
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isComponent" class="tsd-anchor"></a>
|
|
158
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Component</span><a href="#isComponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
159
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
160
|
+
<li class="tsd-signature tsd-anchor-link" id="isComponent.isComponent-1"><span class="tsd-kind-call-signature">is<wbr/>Component</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 ">Component</span><a href="#isComponent.isComponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
161
|
+
<li class="tsd-description">
|
|
162
|
+
<div class="tsd-comment tsd-typography"><p>Test whether the given construct is a component.</p>
|
|
163
|
+
</div>
|
|
164
|
+
<div class="tsd-parameters">
|
|
165
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
166
|
+
<ul class="tsd-parameter-list">
|
|
167
|
+
<li>
|
|
168
|
+
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
169
|
+
<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 ">Component</span></h4>
|
|
170
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
171
|
+
<p>Inherited from pj.Component.isComponent</p></aside></li></ul></section>
|
|
172
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
173
|
+
<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>
|
|
174
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
175
|
+
<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>
|
|
176
|
+
<li class="tsd-description">
|
|
177
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
178
|
+
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
179
|
+
instances, even when the construct library is symlinked.</p>
|
|
180
|
+
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
181
|
+
disk are seen as independent, completely different libraries. As a
|
|
182
|
+
consequence, the class <code>Construct</code> in each copy of the <code>constructs</code> library
|
|
183
|
+
is seen as a different class, and an instance of one class will not test as
|
|
184
|
+
<code>instanceof</code> the other class. <code>npm install</code> will not create installations
|
|
185
|
+
like this, but users may manually symlink construct libraries together or
|
|
186
|
+
use a monorepo tool: in those cases, multiple copies of the <code>constructs</code>
|
|
187
|
+
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
188
|
+
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
189
|
+
this type-testing method instead.</p>
|
|
190
|
+
</div>
|
|
191
|
+
<div class="tsd-parameters">
|
|
192
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
193
|
+
<ul class="tsd-parameter-list">
|
|
194
|
+
<li>
|
|
195
|
+
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
196
|
+
<div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
197
|
+
</div></li></ul></div>
|
|
198
|
+
<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>
|
|
199
|
+
|
|
200
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
201
|
+
<p>Inherited from pj.Component.isConstruct</p></aside></li></ul></section></section></div>
|
|
136
202
|
<div class="col-sidebar">
|
|
137
203
|
<div class="page-menu">
|
|
138
204
|
<div class="tsd-navigation settings">
|
|
@@ -153,6 +219,7 @@
|
|
|
153
219
|
<div class="tsd-accordion-details">
|
|
154
220
|
<ul>
|
|
155
221
|
<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>
|
|
222
|
+
<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>
|
|
156
223
|
<li><a href="#options" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>options</span></a></li>
|
|
157
224
|
<li><a href="#project" 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</span></a></li>
|
|
158
225
|
<li><a href="#createConstructFile" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Construct<wbr/>File</span></a></li>
|
|
@@ -160,7 +227,10 @@
|
|
|
160
227
|
<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>
|
|
161
228
|
<li><a href="#renderDefinitionSubstitution" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Definition<wbr/>Substitution</span></a></li>
|
|
162
229
|
<li><a href="#renderStateConfigDefinition" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span></a></li>
|
|
163
|
-
<li><a href="#synthesize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synthesize</span></a></li
|
|
230
|
+
<li><a href="#synthesize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>synthesize</span></a></li>
|
|
231
|
+
<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>
|
|
232
|
+
<li><a href="#isComponent" 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/>Component</span></a></li>
|
|
233
|
+
<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></ul></div></details></div>
|
|
164
234
|
<div class="site-menu">
|
|
165
235
|
<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>
|
|
166
236
|
<ul class="tsd-small-nested-navigation">
|