cdk-serverless 2.0.1 → 2.0.2
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/main.js +2 -2
- package/docs/constructs/assets/style.css +56 -29
- package/docs/constructs/classes/AssetCdn.html +3 -4
- package/docs/constructs/classes/BaseApi.html +3 -4
- package/docs/constructs/classes/CognitoAuthentication.html +3 -4
- package/docs/constructs/classes/LambdaFunction.html +12 -13
- package/docs/constructs/classes/RestApi.html +9 -10
- package/docs/constructs/classes/SingleTableDatastore.html +3 -4
- package/docs/constructs/classes/Workflow.html +3 -4
- package/docs/constructs/index.html +10 -10
- package/docs/constructs/interfaces/BaseApiProps.html +4 -4
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +2 -2
- package/docs/constructs/interfaces/LambdaFunctionProps.html +2 -2
- package/docs/constructs/interfaces/LambdaTracingOptions.html +1 -1
- package/docs/constructs/interfaces/RestApiProps.html +11 -11
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +1 -1
- package/docs/constructs/interfaces/SingleTableDesign.html +1 -1
- package/docs/lambda/assets/main.js +2 -2
- package/docs/lambda/assets/style.css +56 -29
- package/docs/lambda/functions/api.createAppSyncHandler.html +2 -2
- package/docs/lambda/functions/api.createHttpHandler.html +2 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +2 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +2 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +2 -2
- package/docs/lambda/index.html +10 -10
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +2 -2
- package/docs/lambda/types/api.AppSyncHandler.html +2 -2
- package/docs/lambda/types/api.HttpHandler.html +2 -2
- package/docs/projen/assets/main.js +2 -2
- package/docs/projen/assets/style.css +56 -29
- package/docs/projen/classes/ServerlessProject.html +9 -13
- package/docs/projen/index.html +10 -10
- package/docs/projen/interfaces/ServerlessProjectOptions.html +126 -126
- package/package.json +7 -7
|
@@ -197,7 +197,7 @@ This is normally only allowed for libraries. For apps, there's no meaning
|
|
|
197
197
|
for specifying these.</p>
|
|
198
198
|
|
|
199
199
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
200
|
-
</code></pre>
|
|
200
|
+
</code><button>Copy</button></pre>
|
|
201
201
|
</div><aside class="tsd-sources">
|
|
202
202
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.allowLibraryDependencies</p></aside></section>
|
|
203
203
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appEntrypoint" class="tsd-anchor"></a>
|
|
@@ -207,7 +207,7 @@ for specifying these.</p>
|
|
|
207
207
|
"src" by default).</p>
|
|
208
208
|
|
|
209
209
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"main.ts"</span>
|
|
210
|
-
</code></pre>
|
|
210
|
+
</code><button>Copy</button></pre>
|
|
211
211
|
</div><aside class="tsd-sources">
|
|
212
212
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.appEntrypoint</p></aside></section>
|
|
213
213
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsDirectory" class="tsd-anchor"></a>
|
|
@@ -216,7 +216,7 @@ for specifying these.</p>
|
|
|
216
216
|
<div class="tsd-comment tsd-typography"><p>A directory which will contain build artifacts.</p>
|
|
217
217
|
|
|
218
218
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"dist"</span>
|
|
219
|
-
</code></pre>
|
|
219
|
+
</code><button>Copy</button></pre>
|
|
220
220
|
</div><aside class="tsd-sources">
|
|
221
221
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.artifactsDirectory</p></aside></section>
|
|
222
222
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorEmail" class="tsd-anchor"></a>
|
|
@@ -249,7 +249,7 @@ for specifying these.</p>
|
|
|
249
249
|
<div class="tsd-comment tsd-typography"><p>Enable and configure the 'auto approve' workflow.</p>
|
|
250
250
|
|
|
251
251
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">auto</span><span class="hl-0"> </span><span class="hl-3">approve</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">disabled</span>
|
|
252
|
-
</code></pre>
|
|
252
|
+
</code><button>Copy</button></pre>
|
|
253
253
|
</div><aside class="tsd-sources">
|
|
254
254
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveOptions</p></aside></section>
|
|
255
255
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveUpgrades" class="tsd-anchor"></a>
|
|
@@ -260,7 +260,7 @@ merged by mergify (if configued).</p>
|
|
|
260
260
|
<p>Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
|
|
261
261
|
|
|
262
262
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span>
|
|
263
|
-
</code></pre>
|
|
263
|
+
</code><button>Copy</button></pre>
|
|
264
264
|
</div><aside class="tsd-sources">
|
|
265
265
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveUpgrades</p></aside></section>
|
|
266
266
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoDetectBin" class="tsd-anchor"></a>
|
|
@@ -270,7 +270,7 @@ merged by mergify (if configued).</p>
|
|
|
270
270
|
<code>package.json</code> file under the <code>bin</code> section.</p>
|
|
271
271
|
|
|
272
272
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
273
|
-
</code></pre>
|
|
273
|
+
</code><button>Copy</button></pre>
|
|
274
274
|
</div><aside class="tsd-sources">
|
|
275
275
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoDetectBin</p></aside></section>
|
|
276
276
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMerge" class="tsd-anchor"></a>
|
|
@@ -280,7 +280,7 @@ merged by mergify (if configued).</p>
|
|
|
280
280
|
is set to false.</p>
|
|
281
281
|
|
|
282
282
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
283
|
-
</code></pre>
|
|
283
|
+
</code><button>Copy</button></pre>
|
|
284
284
|
</div><aside class="tsd-sources">
|
|
285
285
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMerge</p></aside></section>
|
|
286
286
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMergeOptions" class="tsd-anchor"></a>
|
|
@@ -323,7 +323,7 @@ running <code>cdk synth</code> or when <code>cdk watch</code> identifies a chang
|
|
|
323
323
|
code before redeployment.</p>
|
|
324
324
|
|
|
325
325
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">build</span><span class="hl-0"> </span><span class="hl-3">command</span>
|
|
326
|
-
</code></pre>
|
|
326
|
+
</code><button>Copy</button></pre>
|
|
327
327
|
</div><aside class="tsd-sources">
|
|
328
328
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildCommand</p></aside></section>
|
|
329
329
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflow" class="tsd-anchor"></a>
|
|
@@ -332,7 +332,7 @@ code before redeployment.</p>
|
|
|
332
332
|
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
|
|
333
333
|
|
|
334
334
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> </span><span class="hl-3">subproject</span>
|
|
335
|
-
</code></pre>
|
|
335
|
+
</code><button>Copy</button></pre>
|
|
336
336
|
</div><aside class="tsd-sources">
|
|
337
337
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflow</p></aside></section>
|
|
338
338
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflowTriggers" class="tsd-anchor"></a>
|
|
@@ -341,7 +341,7 @@ code before redeployment.</p>
|
|
|
341
341
|
<div class="tsd-comment tsd-typography"><p>Build workflow triggers</p>
|
|
342
342
|
|
|
343
343
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"{ pullRequest: {}, workflowDispatch: {} }"</span>
|
|
344
|
-
</code></pre>
|
|
344
|
+
</code><button>Copy</button></pre>
|
|
345
345
|
</div><aside class="tsd-sources">
|
|
346
346
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflowTriggers</p></aside></section>
|
|
347
347
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundledDeps" class="tsd-anchor"></a>
|
|
@@ -371,7 +371,7 @@ this will be what you <code>package.json</code> will eventually include.</p>
|
|
|
371
371
|
Install the @aws-cdk/assert library?</p>
|
|
372
372
|
|
|
373
373
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">will</span><span class="hl-0"> </span><span class="hl-3">be</span><span class="hl-0"> </span><span class="hl-3">included</span><span class="hl-0"> </span><span class="hl-3">by</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">AWS</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> >= </span><span class="hl-6">1.0</span><span class="hl-0">.</span><span class="hl-6">0</span><span class="hl-0"> < </span><span class="hl-6">2.0</span><span class="hl-0">.</span><span class="hl-6">0</span>
|
|
374
|
-
</code></pre>
|
|
374
|
+
</code><button>Copy</button></pre>
|
|
375
375
|
|
|
376
376
|
<h3>Deprecated</h3><p>The @aws-cdk/assert library is deprecated in favor of
|
|
377
377
|
@aws-cdk/assertions (in V1) and included in <code>aws-cdk-lib</code> for V2.</p>
|
|
@@ -385,7 +385,7 @@ Install the @aws-cdk/assert library?</p>
|
|
|
385
385
|
assertions is already included in 'aws-cdk-lib'</p>
|
|
386
386
|
|
|
387
387
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">will</span><span class="hl-0"> </span><span class="hl-3">be</span><span class="hl-0"> </span><span class="hl-3">included</span><span class="hl-0"> </span><span class="hl-3">by</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">AWS</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> >= </span><span class="hl-6">1.111</span><span class="hl-0">.</span><span class="hl-6">0</span><span class="hl-0"> < </span><span class="hl-6">2.0</span><span class="hl-0">.</span><span class="hl-6">0</span>
|
|
388
|
-
</code></pre>
|
|
388
|
+
</code><button>Copy</button></pre>
|
|
389
389
|
</div><aside class="tsd-sources">
|
|
390
390
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssertions</p></aside></section>
|
|
391
391
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependencies" class="tsd-anchor"></a>
|
|
@@ -408,7 +408,7 @@ they are present during development.</p>
|
|
|
408
408
|
<p>Note: this setting only applies to construct library projects</p>
|
|
409
409
|
|
|
410
410
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
411
|
-
</code></pre>
|
|
411
|
+
</code><button>Copy</button></pre>
|
|
412
412
|
|
|
413
413
|
<h3>Deprecated</h3><p>Not supported in CDK v2.</p>
|
|
414
414
|
</div><aside class="tsd-sources">
|
|
@@ -427,7 +427,7 @@ they are present during development.</p>
|
|
|
427
427
|
<div class="tsd-comment tsd-typography"><p>Minimum version of the AWS CDK to depend on.</p>
|
|
428
428
|
|
|
429
429
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"2.1.0"</span>
|
|
430
|
-
</code></pre>
|
|
430
|
+
</code><button>Copy</button></pre>
|
|
431
431
|
</div><aside class="tsd-sources">
|
|
432
432
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersion</p></aside></section>
|
|
433
433
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersionPinning" class="tsd-anchor"></a>
|
|
@@ -444,7 +444,7 @@ If you use experimental features this will let you define the moment you include
|
|
|
444
444
|
<div class="tsd-comment tsd-typography"><p>cdk.out directory.</p>
|
|
445
445
|
|
|
446
446
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"cdk.out"</span>
|
|
447
|
-
</code></pre>
|
|
447
|
+
</code><button>Copy</button></pre>
|
|
448
448
|
</div><aside class="tsd-sources">
|
|
449
449
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkout</p></aside></section>
|
|
450
450
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clobber" class="tsd-anchor"></a>
|
|
@@ -453,7 +453,7 @@ If you use experimental features this will let you define the moment you include
|
|
|
453
453
|
<div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
|
|
454
454
|
|
|
455
455
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0">, </span><span class="hl-3">but</span><span class="hl-0"> </span><span class="hl-2">false</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-3">subprojects</span>
|
|
456
|
-
</code></pre>
|
|
456
|
+
</code><button>Copy</button></pre>
|
|
457
457
|
</div><aside class="tsd-sources">
|
|
458
458
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.clobber</p></aside></section>
|
|
459
459
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeArtifactOptions" class="tsd-anchor"></a>
|
|
@@ -463,7 +463,7 @@ If you use experimental features this will let you define the moment you include
|
|
|
463
463
|
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
|
|
464
464
|
|
|
465
465
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">undefined</span>
|
|
466
|
-
</code></pre>
|
|
466
|
+
</code><button>Copy</button></pre>
|
|
467
467
|
</div><aside class="tsd-sources">
|
|
468
468
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeArtifactOptions</p></aside></section>
|
|
469
469
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCov" class="tsd-anchor"></a>
|
|
@@ -475,7 +475,7 @@ A secret is required for private repos. Configured with</p>
|
|
|
475
475
|
|
|
476
476
|
<h3>Code Cov Token Secret</h3>
|
|
477
477
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
478
|
-
</code></pre>
|
|
478
|
+
</code><button>Copy</button></pre>
|
|
479
479
|
</div><aside class="tsd-sources">
|
|
480
480
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCov</p></aside></section>
|
|
481
481
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCovTokenSecret" class="tsd-anchor"></a>
|
|
@@ -485,7 +485,7 @@ A secret is required for private repos. Configured with</p>
|
|
|
485
485
|
A secret is required to send coverage for private repositories</p>
|
|
486
486
|
|
|
487
487
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-2">this</span><span class="hl-0"> </span><span class="hl-3">option</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">specified</span><span class="hl-0">, </span><span class="hl-3">only</span><span class="hl-0"> </span><span class="hl-3">public</span><span class="hl-0"> </span><span class="hl-3">repositories</span><span class="hl-0"> </span><span class="hl-3">are</span><span class="hl-0"> </span><span class="hl-3">supported</span>
|
|
488
|
-
</code></pre>
|
|
488
|
+
</code><button>Copy</button></pre>
|
|
489
489
|
</div><aside class="tsd-sources">
|
|
490
490
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCovTokenSecret</p></aside></section>
|
|
491
491
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitGenerated" class="tsd-anchor"></a>
|
|
@@ -494,7 +494,7 @@ A secret is required to send coverage for private repositories</p>
|
|
|
494
494
|
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
495
495
|
|
|
496
496
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
497
|
-
</code></pre>
|
|
497
|
+
</code><button>Copy</button></pre>
|
|
498
498
|
</div><aside class="tsd-sources">
|
|
499
499
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.commitGenerated</p></aside></section>
|
|
500
500
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="constructsVersion" class="tsd-anchor"></a>
|
|
@@ -503,7 +503,7 @@ A secret is required to send coverage for private repositories</p>
|
|
|
503
503
|
<div class="tsd-comment tsd-typography"><p>Minimum version of the <code>constructs</code> library to depend on.</p>
|
|
504
504
|
|
|
505
505
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> 1.</span><span class="hl-3">x</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-1">"3.2.27"</span><span class="hl-0">, </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-5">CDK</span><span class="hl-0"> 2.</span><span class="hl-3">x</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">is</span><br/><span class="hl-1">"10.0.5"</span><span class="hl-0">.</span>
|
|
506
|
-
</code></pre>
|
|
506
|
+
</code><button>Copy</button></pre>
|
|
507
507
|
</div><aside class="tsd-sources">
|
|
508
508
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.constructsVersion</p></aside></section>
|
|
509
509
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="context" class="tsd-anchor"></a>
|
|
@@ -512,7 +512,7 @@ A secret is required to send coverage for private repositories</p>
|
|
|
512
512
|
<div class="tsd-comment tsd-typography"><p>Additional context to include in <code>cdk.json</code>.</p>
|
|
513
513
|
|
|
514
514
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">additional</span><span class="hl-0"> </span><span class="hl-3">context</span>
|
|
515
|
-
</code></pre>
|
|
515
|
+
</code><button>Copy</button></pre>
|
|
516
516
|
</div>
|
|
517
517
|
<div class="tsd-type-declaration">
|
|
518
518
|
<h4>Type declaration</h4>
|
|
@@ -536,7 +536,7 @@ A secret is required to send coverage for private repositories</p>
|
|
|
536
536
|
<div class="tsd-comment tsd-typography"><p>The copyright years to put in the LICENSE file.</p>
|
|
537
537
|
|
|
538
538
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">current</span><span class="hl-0"> </span><span class="hl-3">year</span>
|
|
539
|
-
</code></pre>
|
|
539
|
+
</code><button>Copy</button></pre>
|
|
540
540
|
</div><aside class="tsd-sources">
|
|
541
541
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightPeriod</p></aside></section>
|
|
542
542
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultReleaseBranch" class="tsd-anchor"></a>
|
|
@@ -545,7 +545,7 @@ A secret is required to send coverage for private repositories</p>
|
|
|
545
545
|
<div class="tsd-comment tsd-typography"><p>The name of the main release branch.</p>
|
|
546
546
|
|
|
547
547
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"main"</span>
|
|
548
|
-
</code></pre>
|
|
548
|
+
</code><button>Copy</button></pre>
|
|
549
549
|
</div><aside class="tsd-sources">
|
|
550
550
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.defaultReleaseBranch</p></aside></section>
|
|
551
551
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabot" class="tsd-anchor"></a>
|
|
@@ -555,7 +555,7 @@ A secret is required to send coverage for private repositories</p>
|
|
|
555
555
|
Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
556
556
|
|
|
557
557
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
558
|
-
</code></pre>
|
|
558
|
+
</code><button>Copy</button></pre>
|
|
559
559
|
</div><aside class="tsd-sources">
|
|
560
560
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabot</p></aside></section>
|
|
561
561
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabotOptions" class="tsd-anchor"></a>
|
|
@@ -564,7 +564,7 @@ Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
|
564
564
|
<div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
|
|
565
565
|
|
|
566
566
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
567
|
-
</code></pre>
|
|
567
|
+
</code><button>Copy</button></pre>
|
|
568
568
|
</div><aside class="tsd-sources">
|
|
569
569
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabotOptions</p></aside></section>
|
|
570
570
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a>
|
|
@@ -579,10 +579,10 @@ the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <cod
|
|
|
579
579
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
580
580
|
|
|
581
581
|
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">[ </span><span class="hl-1">'express'</span><span class="hl-0">, </span><span class="hl-1">'lodash'</span><span class="hl-0">, </span><span class="hl-1">'foo@^2'</span><span class="hl-0"> ]</span>
|
|
582
|
-
</code></pre>
|
|
582
|
+
</code><button>Copy</button></pre>
|
|
583
583
|
|
|
584
584
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
585
|
-
</code></pre>
|
|
585
|
+
</code><button>Copy</button></pre>
|
|
586
586
|
|
|
587
587
|
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
588
588
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.deps</p></aside></section>
|
|
@@ -593,7 +593,7 @@ this will be what you <code>package.json</code> will eventually include.</p>
|
|
|
593
593
|
Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
594
594
|
|
|
595
595
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
596
|
-
</code></pre>
|
|
596
|
+
</code><button>Copy</button></pre>
|
|
597
597
|
</div><aside class="tsd-sources">
|
|
598
598
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgrade</p></aside></section>
|
|
599
599
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgradeOptions" class="tsd-anchor"></a>
|
|
@@ -602,7 +602,7 @@ Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
|
602
602
|
<div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
|
|
603
603
|
|
|
604
604
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
605
|
-
</code></pre>
|
|
605
|
+
</code><button>Copy</button></pre>
|
|
606
606
|
</div><aside class="tsd-sources">
|
|
607
607
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgradeOptions</p></aside></section>
|
|
608
608
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="description" class="tsd-anchor"></a>
|
|
@@ -620,7 +620,7 @@ See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-description">
|
|
|
620
620
|
<div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces)</p>
|
|
621
621
|
|
|
622
622
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
623
|
-
</code></pre>
|
|
623
|
+
</code><button>Copy</button></pre>
|
|
624
624
|
</div><aside class="tsd-sources">
|
|
625
625
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devContainer</p></aside></section>
|
|
626
626
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devDeps" class="tsd-anchor"></a>
|
|
@@ -637,10 +637,10 @@ the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <cod
|
|
|
637
637
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
638
638
|
|
|
639
639
|
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">[ </span><span class="hl-1">'typescript'</span><span class="hl-0">, </span><span class="hl-1">'@types/express'</span><span class="hl-0"> ]</span>
|
|
640
|
-
</code></pre>
|
|
640
|
+
</code><button>Copy</button></pre>
|
|
641
641
|
|
|
642
642
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
643
|
-
</code></pre>
|
|
643
|
+
</code><button>Copy</button></pre>
|
|
644
644
|
|
|
645
645
|
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
646
646
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devDeps</p></aside></section>
|
|
@@ -651,7 +651,7 @@ this will be what you <code>package.json</code> will eventually include.</p>
|
|
|
651
651
|
tsconfig.json is generated by the jsii compiler).</p>
|
|
652
652
|
|
|
653
653
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
654
|
-
</code></pre>
|
|
654
|
+
</code><button>Copy</button></pre>
|
|
655
655
|
</div><aside class="tsd-sources">
|
|
656
656
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfig</p></aside></section>
|
|
657
657
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfigDev" class="tsd-anchor"></a>
|
|
@@ -660,7 +660,7 @@ tsconfig.json is generated by the jsii compiler).</p>
|
|
|
660
660
|
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.dev.json</code> file.</p>
|
|
661
661
|
|
|
662
662
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
663
|
-
</code></pre>
|
|
663
|
+
</code><button>Copy</button></pre>
|
|
664
664
|
</div><aside class="tsd-sources">
|
|
665
665
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfigDev</p></aside></section>
|
|
666
666
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a>
|
|
@@ -669,7 +669,7 @@ tsconfig.json is generated by the jsii compiler).</p>
|
|
|
669
669
|
<div class="tsd-comment tsd-typography"><p>Docgen by Typedoc</p>
|
|
670
670
|
|
|
671
671
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
672
|
-
</code></pre>
|
|
672
|
+
</code><button>Copy</button></pre>
|
|
673
673
|
</div><aside class="tsd-sources">
|
|
674
674
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docgen</p></aside></section>
|
|
675
675
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsDirectory" class="tsd-anchor"></a>
|
|
@@ -678,7 +678,7 @@ tsconfig.json is generated by the jsii compiler).</p>
|
|
|
678
678
|
<div class="tsd-comment tsd-typography"><p>Docs directory</p>
|
|
679
679
|
|
|
680
680
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"docs"</span>
|
|
681
|
-
</code></pre>
|
|
681
|
+
</code><button>Copy</button></pre>
|
|
682
682
|
</div><aside class="tsd-sources">
|
|
683
683
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docsDirectory</p></aside></section>
|
|
684
684
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="edgeLambdaAutoDiscover" class="tsd-anchor"></a>
|
|
@@ -689,7 +689,7 @@ tsconfig.json is generated by the jsii compiler).</p>
|
|
|
689
689
|
manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
690
690
|
|
|
691
691
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
692
|
-
</code></pre>
|
|
692
|
+
</code><button>Copy</button></pre>
|
|
693
693
|
</div><aside class="tsd-sources">
|
|
694
694
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.edgeLambdaAutoDiscover</p></aside></section>
|
|
695
695
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" class="tsd-anchor"></a>
|
|
@@ -699,7 +699,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
699
699
|
<p>Set to an empty string to not include <code>main</code> in your package.json</p>
|
|
700
700
|
|
|
701
701
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"lib/index.js"</span>
|
|
702
|
-
</code></pre>
|
|
702
|
+
</code><button>Copy</button></pre>
|
|
703
703
|
</div><aside class="tsd-sources">
|
|
704
704
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypoint</p></aside></section>
|
|
705
705
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypointTypes" class="tsd-anchor"></a>
|
|
@@ -708,7 +708,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
708
708
|
<div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
|
|
709
709
|
|
|
710
710
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- .</span><span class="hl-3">d</span><span class="hl-0">.</span><span class="hl-3">ts</span><span class="hl-0"> </span><span class="hl-3">file</span><span class="hl-0"> </span><span class="hl-3">derived</span><span class="hl-0"> </span><span class="hl-3">from</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">project</span><span class="hl-1">'s entrypoint (usually lib/index.d.ts</span><span class="hl-7">)</span>
|
|
711
|
-
</code></pre>
|
|
711
|
+
</code><button>Copy</button></pre>
|
|
712
712
|
</div><aside class="tsd-sources">
|
|
713
713
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypointTypes</p></aside></section>
|
|
714
714
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a>
|
|
@@ -717,7 +717,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
717
717
|
<div class="tsd-comment tsd-typography"><p>Setup eslint.</p>
|
|
718
718
|
|
|
719
719
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
720
|
-
</code></pre>
|
|
720
|
+
</code><button>Copy</button></pre>
|
|
721
721
|
</div><aside class="tsd-sources">
|
|
722
722
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslint</p></aside></section>
|
|
723
723
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslintOptions" class="tsd-anchor"></a>
|
|
@@ -726,7 +726,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
726
726
|
<div class="tsd-comment tsd-typography"><p>Eslint options</p>
|
|
727
727
|
|
|
728
728
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">opinionated</span><span class="hl-0"> </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
729
|
-
</code></pre>
|
|
729
|
+
</code><button>Copy</button></pre>
|
|
730
730
|
</div><aside class="tsd-sources">
|
|
731
731
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslintOptions</p></aside></section>
|
|
732
732
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="featureFlags" class="tsd-anchor"></a>
|
|
@@ -735,7 +735,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
735
735
|
<div class="tsd-comment tsd-typography"><p>Include all feature flags in cdk.json</p>
|
|
736
736
|
|
|
737
737
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
738
|
-
</code></pre>
|
|
738
|
+
</code><button>Copy</button></pre>
|
|
739
739
|
</div><aside class="tsd-sources">
|
|
740
740
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.featureFlags</p></aside></section>
|
|
741
741
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitIgnoreOptions" class="tsd-anchor"></a>
|
|
@@ -757,7 +757,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
757
757
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
758
758
|
|
|
759
759
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
760
|
-
</code></pre>
|
|
760
|
+
</code><button>Copy</button></pre>
|
|
761
761
|
</div><aside class="tsd-sources">
|
|
762
762
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.github</p></aside></section>
|
|
763
763
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="githubOptions" class="tsd-anchor"></a>
|
|
@@ -766,7 +766,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
766
766
|
<div class="tsd-comment tsd-typography"><p>Options for GitHub integration</p>
|
|
767
767
|
|
|
768
768
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">see</span><span class="hl-0"> </span><span class="hl-3">GitHubOptions</span>
|
|
769
|
-
</code></pre>
|
|
769
|
+
</code><button>Copy</button></pre>
|
|
770
770
|
</div><aside class="tsd-sources">
|
|
771
771
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.githubOptions</p></aside></section>
|
|
772
772
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a>
|
|
@@ -781,7 +781,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
781
781
|
<div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment</p>
|
|
782
782
|
|
|
783
783
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
784
|
-
</code></pre>
|
|
784
|
+
</code><button>Copy</button></pre>
|
|
785
785
|
</div><aside class="tsd-sources">
|
|
786
786
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitpod</p></aside></section>
|
|
787
787
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="homepage" class="tsd-anchor"></a>
|
|
@@ -797,7 +797,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
|
797
797
|
file in under your test directory.</p>
|
|
798
798
|
|
|
799
799
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
800
|
-
</code></pre>
|
|
800
|
+
</code><button>Copy</button></pre>
|
|
801
801
|
</div><aside class="tsd-sources">
|
|
802
802
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.integrationTestAutoDiscover</p></aside></section>
|
|
803
803
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jest" class="tsd-anchor"></a>
|
|
@@ -806,7 +806,7 @@ file in under your test directory.</p>
|
|
|
806
806
|
<div class="tsd-comment tsd-typography"><p>Setup jest unit tests</p>
|
|
807
807
|
|
|
808
808
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
809
|
-
</code></pre>
|
|
809
|
+
</code><button>Copy</button></pre>
|
|
810
810
|
</div><aside class="tsd-sources">
|
|
811
811
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jest</p></aside></section>
|
|
812
812
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jestOptions" class="tsd-anchor"></a>
|
|
@@ -815,7 +815,7 @@ file in under your test directory.</p>
|
|
|
815
815
|
<div class="tsd-comment tsd-typography"><p>Jest options</p>
|
|
816
816
|
|
|
817
817
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
818
|
-
</code></pre>
|
|
818
|
+
</code><button>Copy</button></pre>
|
|
819
819
|
</div><aside class="tsd-sources">
|
|
820
820
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jestOptions</p></aside></section>
|
|
821
821
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jsiiReleaseVersion" class="tsd-anchor"></a>
|
|
@@ -824,7 +824,7 @@ file in under your test directory.</p>
|
|
|
824
824
|
<div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
825
825
|
|
|
826
826
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"latest"</span>
|
|
827
|
-
</code></pre>
|
|
827
|
+
</code><button>Copy</button></pre>
|
|
828
828
|
</div><aside class="tsd-sources">
|
|
829
829
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jsiiReleaseVersion</p></aside></section>
|
|
830
830
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keywords" class="tsd-anchor"></a>
|
|
@@ -841,7 +841,7 @@ in your source tree. If this is disabled, you can manually add an
|
|
|
841
841
|
<code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
842
842
|
|
|
843
843
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
844
|
-
</code></pre>
|
|
844
|
+
</code><button>Copy</button></pre>
|
|
845
845
|
</div><aside class="tsd-sources">
|
|
846
846
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaAutoDiscover</p></aside></section>
|
|
847
847
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaExtensionAutoDiscover" class="tsd-anchor"></a>
|
|
@@ -852,7 +852,7 @@ entrypoint in your source tree. If this is disabled, you can manually add an
|
|
|
852
852
|
<code>awscdk.AutoDiscover</code> component to your project</p>
|
|
853
853
|
|
|
854
854
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
855
|
-
</code></pre>
|
|
855
|
+
</code><button>Copy</button></pre>
|
|
856
856
|
</div><aside class="tsd-sources">
|
|
857
857
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaExtensionAutoDiscover</p></aside></section>
|
|
858
858
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
@@ -861,7 +861,7 @@ entrypoint in your source tree. If this is disabled, you can manually add an
|
|
|
861
861
|
<div class="tsd-comment tsd-typography"><p>Common options for all AWS Lambda functions.</p>
|
|
862
862
|
|
|
863
863
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
864
|
-
</code></pre>
|
|
864
|
+
</code><button>Copy</button></pre>
|
|
865
865
|
</div><aside class="tsd-sources">
|
|
866
866
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaOptions</p></aside></section>
|
|
867
867
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="libdir" class="tsd-anchor"></a>
|
|
@@ -870,7 +870,7 @@ entrypoint in your source tree. If this is disabled, you can manually add an
|
|
|
870
870
|
<div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory</p>
|
|
871
871
|
|
|
872
872
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"lib"</span>
|
|
873
|
-
</code></pre>
|
|
873
|
+
</code><button>Copy</button></pre>
|
|
874
874
|
</div><aside class="tsd-sources">
|
|
875
875
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.libdir</p></aside></section>
|
|
876
876
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="license" class="tsd-anchor"></a>
|
|
@@ -881,7 +881,7 @@ See <a href="https://github.com/projen/projen/tree/main/license-text">https://gi
|
|
|
881
881
|
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
882
882
|
|
|
883
883
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"Apache-2.0"</span>
|
|
884
|
-
</code></pre>
|
|
884
|
+
</code><button>Copy</button></pre>
|
|
885
885
|
</div><aside class="tsd-sources">
|
|
886
886
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.license</p></aside></section>
|
|
887
887
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="licensed" class="tsd-anchor"></a>
|
|
@@ -890,7 +890,7 @@ Use the <code>licensed</code> option if you want to no license to be specified.<
|
|
|
890
890
|
<div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
891
891
|
|
|
892
892
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
893
|
-
</code></pre>
|
|
893
|
+
</code><button>Copy</button></pre>
|
|
894
894
|
</div><aside class="tsd-sources">
|
|
895
895
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.licensed</p></aside></section>
|
|
896
896
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logging" class="tsd-anchor"></a>
|
|
@@ -899,7 +899,7 @@ Use the <code>licensed</code> option if you want to no license to be specified.<
|
|
|
899
899
|
<div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
900
900
|
|
|
901
901
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">{}</span>
|
|
902
|
-
</code></pre>
|
|
902
|
+
</code><button>Copy</button></pre>
|
|
903
903
|
</div><aside class="tsd-sources">
|
|
904
904
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.logging</p></aside></section>
|
|
905
905
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="majorVersion" class="tsd-anchor"></a>
|
|
@@ -910,7 +910,7 @@ Use the <code>licensed</code> option if you want to no license to be specified.<
|
|
|
910
910
|
If not specified, we bump the global latest version.</p>
|
|
911
911
|
|
|
912
912
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">Major</span><span class="hl-0"> </span><span class="hl-3">version</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">enforced</span><span class="hl-0">.</span>
|
|
913
|
-
</code></pre>
|
|
913
|
+
</code><button>Copy</button></pre>
|
|
914
914
|
</div><aside class="tsd-sources">
|
|
915
915
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.majorVersion</p></aside></section>
|
|
916
916
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" class="tsd-anchor"></a>
|
|
@@ -919,7 +919,7 @@ If not specified, we bump the global latest version.</p>
|
|
|
919
919
|
<div class="tsd-comment tsd-typography"><p>Minimum node.js version to require via <code>engines</code> (inclusive).</p>
|
|
920
920
|
|
|
921
921
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">max</span>
|
|
922
|
-
</code></pre>
|
|
922
|
+
</code><button>Copy</button></pre>
|
|
923
923
|
</div><aside class="tsd-sources">
|
|
924
924
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.maxNodeVersion</p></aside></section>
|
|
925
925
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergify" class="tsd-anchor"></a>
|
|
@@ -928,7 +928,7 @@ If not specified, we bump the global latest version.</p>
|
|
|
928
928
|
<div class="tsd-comment tsd-typography"><p>Whether mergify should be enabled on this repository or not.</p>
|
|
929
929
|
|
|
930
930
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
931
|
-
</code></pre>
|
|
931
|
+
</code><button>Copy</button></pre>
|
|
932
932
|
|
|
933
933
|
<h3>Deprecated</h3><p>use <code>githubOptions.mergify</code> instead</p>
|
|
934
934
|
</div><aside class="tsd-sources">
|
|
@@ -939,7 +939,7 @@ If not specified, we bump the global latest version.</p>
|
|
|
939
939
|
<div class="tsd-comment tsd-typography"><p>Options for mergify</p>
|
|
940
940
|
|
|
941
941
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
942
|
-
</code></pre>
|
|
942
|
+
</code><button>Copy</button></pre>
|
|
943
943
|
|
|
944
944
|
<h3>Deprecated</h3><p>use <code>githubOptions.mergifyOptions</code> instead</p>
|
|
945
945
|
</div><aside class="tsd-sources">
|
|
@@ -953,7 +953,7 @@ release are not incrementing the major version number.</p>
|
|
|
953
953
|
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
954
954
|
|
|
955
955
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">No</span><span class="hl-0"> </span><span class="hl-3">minimum</span><span class="hl-0"> </span><span class="hl-3">version</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">being</span><span class="hl-0"> </span><span class="hl-3">enforced</span>
|
|
956
|
-
</code></pre>
|
|
956
|
+
</code><button>Copy</button></pre>
|
|
957
957
|
</div><aside class="tsd-sources">
|
|
958
958
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minMajorVersion</p></aside></section>
|
|
959
959
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" class="tsd-anchor"></a>
|
|
@@ -962,7 +962,7 @@ release are not incrementing the major version number.</p>
|
|
|
962
962
|
<div class="tsd-comment tsd-typography"><p>Minimum Node.js version to require via package.json <code>engines</code> (inclusive).</p>
|
|
963
963
|
|
|
964
964
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-1">"engines"</span><span class="hl-0"> </span><span class="hl-3">specified</span>
|
|
965
|
-
</code></pre>
|
|
965
|
+
</code><button>Copy</button></pre>
|
|
966
966
|
</div><aside class="tsd-sources">
|
|
967
967
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minNodeVersion</p></aside></section>
|
|
968
968
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mutableBuild" class="tsd-anchor"></a>
|
|
@@ -974,7 +974,7 @@ before a PR is merged.</p>
|
|
|
974
974
|
<p>Implies that PR builds do not have anti-tamper checks.</p>
|
|
975
975
|
|
|
976
976
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
977
|
-
</code></pre>
|
|
977
|
+
</code><button>Copy</button></pre>
|
|
978
978
|
</div><aside class="tsd-sources">
|
|
979
979
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mutableBuild</p></aside></section>
|
|
980
980
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
|
|
@@ -983,7 +983,7 @@ before a PR is merged.</p>
|
|
|
983
983
|
<div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
984
984
|
|
|
985
985
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">$BASEDIR</span>
|
|
986
|
-
</code></pre>
|
|
986
|
+
</code><button>Copy</button></pre>
|
|
987
987
|
|
|
988
988
|
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
989
989
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.name</p></aside></section>
|
|
@@ -1007,7 +1007,7 @@ before a PR is merged.</p>
|
|
|
1007
1007
|
for each branch.</p>
|
|
1008
1008
|
|
|
1009
1009
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"latest"</span>
|
|
1010
|
-
</code></pre>
|
|
1010
|
+
</code><button>Copy</button></pre>
|
|
1011
1011
|
</div><aside class="tsd-sources">
|
|
1012
1012
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmDistTag</p></aside></section>
|
|
1013
1013
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmIgnoreOptions" class="tsd-anchor"></a>
|
|
@@ -1031,7 +1031,7 @@ for each branch.</p>
|
|
|
1031
1031
|
<p>Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
1032
1032
|
|
|
1033
1033
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"https://registry.npmjs.org"</span>
|
|
1034
|
-
</code></pre>
|
|
1034
|
+
</code><button>Copy</button></pre>
|
|
1035
1035
|
</div><aside class="tsd-sources">
|
|
1036
1036
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistryUrl</p></aside></section>
|
|
1037
1037
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmTokenSecret" class="tsd-anchor"></a>
|
|
@@ -1040,7 +1040,7 @@ for each branch.</p>
|
|
|
1040
1040
|
<div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
1041
1041
|
|
|
1042
1042
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"NPM_TOKEN"</span>
|
|
1043
|
-
</code></pre>
|
|
1043
|
+
</code><button>Copy</button></pre>
|
|
1044
1044
|
</div><aside class="tsd-sources">
|
|
1045
1045
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmTokenSecret</p></aside></section>
|
|
1046
1046
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a>
|
|
@@ -1060,7 +1060,7 @@ for each branch.</p>
|
|
|
1060
1060
|
are packaged as tarballs.</p>
|
|
1061
1061
|
|
|
1062
1062
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1063
|
-
</code></pre>
|
|
1063
|
+
</code><button>Copy</button></pre>
|
|
1064
1064
|
</div><aside class="tsd-sources">
|
|
1065
1065
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignoreEnabled</p></aside></section>
|
|
1066
1066
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
@@ -1073,7 +1073,7 @@ directory and it cannot be the same as the parent or any of it's other
|
|
|
1073
1073
|
sub-projects.</p>
|
|
1074
1074
|
|
|
1075
1075
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"."</span>
|
|
1076
|
-
</code></pre>
|
|
1076
|
+
</code><button>Copy</button></pre>
|
|
1077
1077
|
</div><aside class="tsd-sources">
|
|
1078
1078
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.outdir</p></aside></section>
|
|
1079
1079
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a>
|
|
@@ -1083,7 +1083,7 @@ sub-projects.</p>
|
|
|
1083
1083
|
artifacts directory (e.g. <code>dist</code>).</p>
|
|
1084
1084
|
|
|
1085
1085
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1086
|
-
</code></pre>
|
|
1086
|
+
</code><button>Copy</button></pre>
|
|
1087
1087
|
</div><aside class="tsd-sources">
|
|
1088
1088
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.package</p></aside></section>
|
|
1089
1089
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
@@ -1092,7 +1092,7 @@ artifacts directory (e.g. <code>dist</code>).</p>
|
|
|
1092
1092
|
<div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts</p>
|
|
1093
1093
|
|
|
1094
1094
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">NodePackageManager</span><span class="hl-0">.</span><span class="hl-5">YARN</span>
|
|
1095
|
-
</code></pre>
|
|
1095
|
+
</code><button>Copy</button></pre>
|
|
1096
1096
|
</div><aside class="tsd-sources">
|
|
1097
1097
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageManager</p></aside></section>
|
|
1098
1098
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageName" class="tsd-anchor"></a>
|
|
@@ -1101,7 +1101,7 @@ artifacts directory (e.g. <code>dist</code>).</p>
|
|
|
1101
1101
|
<div class="tsd-comment tsd-typography"><p>The "name" in package.json</p>
|
|
1102
1102
|
|
|
1103
1103
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">defaults</span><span class="hl-0"> </span><span class="hl-3">to</span><span class="hl-0"> </span><span class="hl-3">project</span><span class="hl-0"> </span><span class="hl-3">name</span>
|
|
1104
|
-
</code></pre>
|
|
1104
|
+
</code><button>Copy</button></pre>
|
|
1105
1105
|
|
|
1106
1106
|
<h3>Featured</h3></div><aside class="tsd-sources">
|
|
1107
1107
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageName</p></aside></section>
|
|
@@ -1133,7 +1133,7 @@ pinned version for each peer dependency. This will ensure that you build &
|
|
|
1133
1133
|
test your module against the lowest peer version required.</p>
|
|
1134
1134
|
|
|
1135
1135
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1136
|
-
</code></pre>
|
|
1136
|
+
</code><button>Copy</button></pre>
|
|
1137
1137
|
</div><aside class="tsd-sources">
|
|
1138
1138
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDeps</p></aside></section>
|
|
1139
1139
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pnpmVersion" class="tsd-anchor"></a>
|
|
@@ -1142,7 +1142,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1142
1142
|
<div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
1143
1143
|
|
|
1144
1144
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"7"</span>
|
|
1145
|
-
</code></pre>
|
|
1145
|
+
</code><button>Copy</button></pre>
|
|
1146
1146
|
</div><aside class="tsd-sources">
|
|
1147
1147
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pnpmVersion</p></aside></section>
|
|
1148
1148
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postBuildSteps" class="tsd-anchor"></a>
|
|
@@ -1151,7 +1151,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1151
1151
|
<div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
1152
1152
|
|
|
1153
1153
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1154
|
-
</code></pre>
|
|
1154
|
+
</code><button>Copy</button></pre>
|
|
1155
1155
|
</div><aside class="tsd-sources">
|
|
1156
1156
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.postBuildSteps</p></aside></section>
|
|
1157
1157
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prerelease" class="tsd-anchor"></a>
|
|
@@ -1161,7 +1161,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1161
1161
|
"alpha", "pre").</p>
|
|
1162
1162
|
|
|
1163
1163
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">normal</span><span class="hl-0"> </span><span class="hl-3">semantic</span><span class="hl-0"> </span><span class="hl-3">versions</span>
|
|
1164
|
-
</code></pre>
|
|
1164
|
+
</code><button>Copy</button></pre>
|
|
1165
1165
|
</div><aside class="tsd-sources">
|
|
1166
1166
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prerelease</p></aside></section>
|
|
1167
1167
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" class="tsd-anchor"></a>
|
|
@@ -1170,7 +1170,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1170
1170
|
<div class="tsd-comment tsd-typography"><p>Setup prettier.</p>
|
|
1171
1171
|
|
|
1172
1172
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1173
|
-
</code></pre>
|
|
1173
|
+
</code><button>Copy</button></pre>
|
|
1174
1174
|
</div><aside class="tsd-sources">
|
|
1175
1175
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettier</p></aside></section>
|
|
1176
1176
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettierOptions" class="tsd-anchor"></a>
|
|
@@ -1179,7 +1179,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1179
1179
|
<div class="tsd-comment tsd-typography"><p>Prettier options</p>
|
|
1180
1180
|
|
|
1181
1181
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1182
|
-
</code></pre>
|
|
1182
|
+
</code><button>Copy</button></pre>
|
|
1183
1183
|
</div><aside class="tsd-sources">
|
|
1184
1184
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettierOptions</p></aside></section>
|
|
1185
1185
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectType" class="tsd-anchor"></a>
|
|
@@ -1188,7 +1188,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1188
1188
|
<div class="tsd-comment tsd-typography"><p>Which type of project this is (library/app).</p>
|
|
1189
1189
|
|
|
1190
1190
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">ProjectType</span><span class="hl-0">.</span><span class="hl-5">UNKNOWN</span>
|
|
1191
|
-
</code></pre>
|
|
1191
|
+
</code><button>Copy</button></pre>
|
|
1192
1192
|
|
|
1193
1193
|
<h3>Deprecated</h3><p>no longer supported at the base project level</p>
|
|
1194
1194
|
</div><aside class="tsd-sources">
|
|
@@ -1200,7 +1200,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1200
1200
|
<p>Can be used to customize in special environments.</p>
|
|
1201
1201
|
|
|
1202
1202
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"npx projen"</span>
|
|
1203
|
-
</code></pre>
|
|
1203
|
+
</code><button>Copy</button></pre>
|
|
1204
1204
|
</div><aside class="tsd-sources">
|
|
1205
1205
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCommand</p></aside></section>
|
|
1206
1206
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCredentials" class="tsd-anchor"></a>
|
|
@@ -1209,7 +1209,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1209
1209
|
<div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
1210
1210
|
|
|
1211
1211
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">use</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> </span><span class="hl-3">personal</span><span class="hl-0"> </span><span class="hl-3">access</span><span class="hl-0"> </span><span class="hl-3">token</span><span class="hl-0"> </span><span class="hl-3">named</span><span class="hl-0"> </span><span class="hl-5">PROJEN_GITHUB_TOKEN</span>
|
|
1212
|
-
</code></pre>
|
|
1212
|
+
</code><button>Copy</button></pre>
|
|
1213
1213
|
</div><aside class="tsd-sources">
|
|
1214
1214
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCredentials</p></aside></section>
|
|
1215
1215
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenDevDependency" class="tsd-anchor"></a>
|
|
@@ -1218,7 +1218,7 @@ test your module against the lowest peer version required.</p>
|
|
|
1218
1218
|
<div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
1219
1219
|
|
|
1220
1220
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1221
|
-
</code></pre>
|
|
1221
|
+
</code><button>Copy</button></pre>
|
|
1222
1222
|
</div><aside class="tsd-sources">
|
|
1223
1223
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenDevDependency</p></aside></section>
|
|
1224
1224
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenTokenSecret" class="tsd-anchor"></a>
|
|
@@ -1229,7 +1229,7 @@ used by projen workflows. This token needs to have the <code>repo</code>, <code>
|
|
|
1229
1229
|
and <code>packages</code> scope.</p>
|
|
1230
1230
|
|
|
1231
1231
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"PROJEN_GITHUB_TOKEN"</span>
|
|
1232
|
-
</code></pre>
|
|
1232
|
+
</code><button>Copy</button></pre>
|
|
1233
1233
|
|
|
1234
1234
|
<h3>Deprecated</h3><p>use <code>projenCredentials</code></p>
|
|
1235
1235
|
</div><aside class="tsd-sources">
|
|
@@ -1240,7 +1240,7 @@ and <code>packages</code> scope.</p>
|
|
|
1240
1240
|
<div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
1241
1241
|
|
|
1242
1242
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">Defaults</span><span class="hl-0"> </span><span class="hl-3">to</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">latest</span><span class="hl-0"> </span><span class="hl-3">version</span><span class="hl-0">.</span>
|
|
1243
|
-
</code></pre>
|
|
1243
|
+
</code><button>Copy</button></pre>
|
|
1244
1244
|
</div><aside class="tsd-sources">
|
|
1245
1245
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenVersion</p></aside></section>
|
|
1246
1246
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJs" class="tsd-anchor"></a>
|
|
@@ -1250,7 +1250,7 @@ and <code>packages</code> scope.</p>
|
|
|
1250
1250
|
.projenrc.js generation.</p>
|
|
1251
1251
|
|
|
1252
1252
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-3">projenrcJson</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-2">false</span>
|
|
1253
|
-
</code></pre>
|
|
1253
|
+
</code><button>Copy</button></pre>
|
|
1254
1254
|
</div><aside class="tsd-sources">
|
|
1255
1255
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJs</p></aside></section>
|
|
1256
1256
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsOptions" class="tsd-anchor"></a>
|
|
@@ -1259,7 +1259,7 @@ and <code>packages</code> scope.</p>
|
|
|
1259
1259
|
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.js</p>
|
|
1260
1260
|
|
|
1261
1261
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1262
|
-
</code></pre>
|
|
1262
|
+
</code><button>Copy</button></pre>
|
|
1263
1263
|
</div><aside class="tsd-sources">
|
|
1264
1264
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsOptions</p></aside></section>
|
|
1265
1265
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJson" class="tsd-anchor"></a>
|
|
@@ -1269,7 +1269,7 @@ and <code>packages</code> scope.</p>
|
|
|
1269
1269
|
.projenrc.json generation.</p>
|
|
1270
1270
|
|
|
1271
1271
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1272
|
-
</code></pre>
|
|
1272
|
+
</code><button>Copy</button></pre>
|
|
1273
1273
|
</div><aside class="tsd-sources">
|
|
1274
1274
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJson</p></aside></section>
|
|
1275
1275
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsonOptions" class="tsd-anchor"></a>
|
|
@@ -1278,7 +1278,7 @@ and <code>packages</code> scope.</p>
|
|
|
1278
1278
|
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.json</p>
|
|
1279
1279
|
|
|
1280
1280
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1281
|
-
</code></pre>
|
|
1281
|
+
</code><button>Copy</button></pre>
|
|
1282
1282
|
</div><aside class="tsd-sources">
|
|
1283
1283
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsonOptions</p></aside></section>
|
|
1284
1284
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTs" class="tsd-anchor"></a>
|
|
@@ -1287,7 +1287,7 @@ and <code>packages</code> scope.</p>
|
|
|
1287
1287
|
<div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
1288
1288
|
|
|
1289
1289
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1290
|
-
</code></pre>
|
|
1290
|
+
</code><button>Copy</button></pre>
|
|
1291
1291
|
|
|
1292
1292
|
<h3>Pjnew</h3><p>true</p>
|
|
1293
1293
|
</div><aside class="tsd-sources">
|
|
@@ -1304,7 +1304,7 @@ and <code>packages</code> scope.</p>
|
|
|
1304
1304
|
<div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
1305
1305
|
|
|
1306
1306
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1307
|
-
</code></pre>
|
|
1307
|
+
</code><button>Copy</button></pre>
|
|
1308
1308
|
</div><aside class="tsd-sources">
|
|
1309
1309
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishDryRun</p></aside></section>
|
|
1310
1310
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishTasks" class="tsd-anchor"></a>
|
|
@@ -1315,7 +1315,7 @@ and <code>packages</code> scope.</p>
|
|
|
1315
1315
|
in order to create a publishing task for each publishing activity.</p>
|
|
1316
1316
|
|
|
1317
1317
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1318
|
-
</code></pre>
|
|
1318
|
+
</code><button>Copy</button></pre>
|
|
1319
1319
|
</div><aside class="tsd-sources">
|
|
1320
1320
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishTasks</p></aside></section>
|
|
1321
1321
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplate" class="tsd-anchor"></a>
|
|
@@ -1324,7 +1324,7 @@ in order to create a publishing task for each publishing activity.</p>
|
|
|
1324
1324
|
<div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
1325
1325
|
|
|
1326
1326
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1327
|
-
</code></pre>
|
|
1327
|
+
</code><button>Copy</button></pre>
|
|
1328
1328
|
</div><aside class="tsd-sources">
|
|
1329
1329
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplate</p></aside></section>
|
|
1330
1330
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplateContents" class="tsd-anchor"></a>
|
|
@@ -1333,7 +1333,7 @@ in order to create a publishing task for each publishing activity.</p>
|
|
|
1333
1333
|
<div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
|
|
1334
1334
|
|
|
1335
1335
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">content</span>
|
|
1336
|
-
</code></pre>
|
|
1336
|
+
</code><button>Copy</button></pre>
|
|
1337
1337
|
</div><aside class="tsd-sources">
|
|
1338
1338
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplateContents</p></aside></section>
|
|
1339
1339
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readme" class="tsd-anchor"></a>
|
|
@@ -1342,10 +1342,10 @@ in order to create a publishing task for each publishing activity.</p>
|
|
|
1342
1342
|
<div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
1343
1343
|
|
|
1344
1344
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- { </span><span class="hl-8">filename</span><span class="hl-0">: </span><span class="hl-1">'README.md'</span><span class="hl-0">, </span><span class="hl-8">contents</span><span class="hl-0">: </span><span class="hl-1">'# replace this'</span><span class="hl-0"> }</span>
|
|
1345
|
-
</code></pre>
|
|
1345
|
+
</code><button>Copy</button></pre>
|
|
1346
1346
|
|
|
1347
1347
|
<h3>Example</h3><pre><code class="language-ts"><span class="hl-1">"{ filename: 'readme.md', contents: '# title' }"</span>
|
|
1348
|
-
</code></pre>
|
|
1348
|
+
</code><button>Copy</button></pre>
|
|
1349
1349
|
</div><aside class="tsd-sources">
|
|
1350
1350
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.readme</p></aside></section>
|
|
1351
1351
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a>
|
|
@@ -1354,7 +1354,7 @@ in order to create a publishing task for each publishing activity.</p>
|
|
|
1354
1354
|
<div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
1355
1355
|
|
|
1356
1356
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> (</span><span class="hl-2">false</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-3">subprojects</span><span class="hl-0">)</span>
|
|
1357
|
-
</code></pre>
|
|
1357
|
+
</code><button>Copy</button></pre>
|
|
1358
1358
|
</div><aside class="tsd-sources">
|
|
1359
1359
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.release</p></aside></section>
|
|
1360
1360
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseBranches" class="tsd-anchor"></a>
|
|
@@ -1384,7 +1384,7 @@ be provided for the default branch.</p>
|
|
|
1384
1384
|
<div class="tsd-comment tsd-typography"><p>Automatically release new versions every commit to one of branches in <code>releaseBranches</code>.</p>
|
|
1385
1385
|
|
|
1386
1386
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1387
|
-
</code></pre>
|
|
1387
|
+
</code><button>Copy</button></pre>
|
|
1388
1388
|
|
|
1389
1389
|
<h3>Deprecated</h3><p>Use <code>releaseTrigger: ReleaseTrigger.continuous()</code> instead</p>
|
|
1390
1390
|
</div><aside class="tsd-sources">
|
|
@@ -1395,7 +1395,7 @@ be provided for the default branch.</p>
|
|
|
1395
1395
|
<div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
1396
1396
|
|
|
1397
1397
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1398
|
-
</code></pre>
|
|
1398
|
+
</code><button>Copy</button></pre>
|
|
1399
1399
|
</div><aside class="tsd-sources">
|
|
1400
1400
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssue</p></aside></section>
|
|
1401
1401
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssueLabel" class="tsd-anchor"></a>
|
|
@@ -1405,7 +1405,7 @@ be provided for the default branch.</p>
|
|
|
1405
1405
|
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
1406
1406
|
|
|
1407
1407
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"failed-release"</span>
|
|
1408
|
-
</code></pre>
|
|
1408
|
+
</code><button>Copy</button></pre>
|
|
1409
1409
|
</div><aside class="tsd-sources">
|
|
1410
1410
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssueLabel</p></aside></section>
|
|
1411
1411
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseSchedule" class="tsd-anchor"></a>
|
|
@@ -1414,7 +1414,7 @@ Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
|
1414
1414
|
<div class="tsd-comment tsd-typography"><p>CRON schedule to trigger new releases.</p>
|
|
1415
1415
|
|
|
1416
1416
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">scheduled</span><span class="hl-0"> </span><span class="hl-3">releases</span>
|
|
1417
|
-
</code></pre>
|
|
1417
|
+
</code><button>Copy</button></pre>
|
|
1418
1418
|
|
|
1419
1419
|
<h3>Deprecated</h3><p>Use <code>releaseTrigger: ReleaseTrigger.scheduled()</code> instead</p>
|
|
1420
1420
|
</div><aside class="tsd-sources">
|
|
@@ -1431,7 +1431,7 @@ history, you may need to manually tag your latest release
|
|
|
1431
1431
|
with the new prefix.</p>
|
|
1432
1432
|
|
|
1433
1433
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"v"</span>
|
|
1434
|
-
</code></pre>
|
|
1434
|
+
</code><button>Copy</button></pre>
|
|
1435
1435
|
</div><aside class="tsd-sources">
|
|
1436
1436
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTagPrefix</p></aside></section>
|
|
1437
1437
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseToNpm" class="tsd-anchor"></a>
|
|
@@ -1440,7 +1440,7 @@ with the new prefix.</p>
|
|
|
1440
1440
|
<div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
1441
1441
|
|
|
1442
1442
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1443
|
-
</code></pre>
|
|
1443
|
+
</code><button>Copy</button></pre>
|
|
1444
1444
|
</div><aside class="tsd-sources">
|
|
1445
1445
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseToNpm</p></aside></section>
|
|
1446
1446
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTrigger" class="tsd-anchor"></a>
|
|
@@ -1459,7 +1459,7 @@ with the new prefix.</p>
|
|
|
1459
1459
|
<div class="tsd-comment tsd-typography"><p>DEPRECATED: renamed to <code>release</code>.</p>
|
|
1460
1460
|
|
|
1461
1461
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-2">true</span><span class="hl-0"> </span><span class="hl-4">if</span><span class="hl-0"> </span><span class="hl-3">not</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> </span><span class="hl-3">subproject</span>
|
|
1462
|
-
</code></pre>
|
|
1462
|
+
</code><button>Copy</button></pre>
|
|
1463
1463
|
|
|
1464
1464
|
<h3>Deprecated</h3><p>see <code>release</code>.</p>
|
|
1465
1465
|
</div><aside class="tsd-sources">
|
|
@@ -1470,7 +1470,7 @@ with the new prefix.</p>
|
|
|
1470
1470
|
<div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
1471
1471
|
|
|
1472
1472
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"Release"</span>
|
|
1473
|
-
</code></pre>
|
|
1473
|
+
</code><button>Copy</button></pre>
|
|
1474
1474
|
</div><aside class="tsd-sources">
|
|
1475
1475
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowName</p></aside></section>
|
|
1476
1476
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowSetupSteps" class="tsd-anchor"></a>
|
|
@@ -1486,7 +1486,7 @@ container.</p>
|
|
|
1486
1486
|
<div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
1487
1487
|
|
|
1488
1488
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1489
|
-
</code></pre>
|
|
1489
|
+
</code><button>Copy</button></pre>
|
|
1490
1490
|
</div><aside class="tsd-sources">
|
|
1491
1491
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebot</p></aside></section>
|
|
1492
1492
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebotOptions" class="tsd-anchor"></a>
|
|
@@ -1495,7 +1495,7 @@ container.</p>
|
|
|
1495
1495
|
<div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
1496
1496
|
|
|
1497
1497
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1498
|
-
</code></pre>
|
|
1498
|
+
</code><button>Copy</button></pre>
|
|
1499
1499
|
</div><aside class="tsd-sources">
|
|
1500
1500
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebotOptions</p></aside></section>
|
|
1501
1501
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repository" class="tsd-anchor"></a>
|
|
@@ -1519,7 +1519,7 @@ you can specify the directory in which it lives.</p>
|
|
|
1519
1519
|
the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.</p>
|
|
1520
1520
|
|
|
1521
1521
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-3">ApprovalLevel</span><span class="hl-0">.</span><span class="hl-5">BROADENING</span>
|
|
1522
|
-
</code></pre>
|
|
1522
|
+
</code><button>Copy</button></pre>
|
|
1523
1523
|
</div><aside class="tsd-sources">
|
|
1524
1524
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.requireApproval</p></aside></section>
|
|
1525
1525
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sampleCode" class="tsd-anchor"></a>
|
|
@@ -1528,7 +1528,7 @@ the AWS CDK Toolkit prompts you to approve security-related changes before deplo
|
|
|
1528
1528
|
<div class="tsd-comment tsd-typography"><p>Generate one-time sample in <code>src/</code> and <code>test/</code> if there are no files there.</p>
|
|
1529
1529
|
|
|
1530
1530
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1531
|
-
</code></pre>
|
|
1531
|
+
</code><button>Copy</button></pre>
|
|
1532
1532
|
</div><aside class="tsd-sources">
|
|
1533
1533
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.sampleCode</p></aside></section>
|
|
1534
1534
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scopedPackagesOptions" class="tsd-anchor"></a>
|
|
@@ -1537,7 +1537,7 @@ the AWS CDK Toolkit prompts you to approve security-related changes before deplo
|
|
|
1537
1537
|
<div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages</p>
|
|
1538
1538
|
|
|
1539
1539
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">fetch</span><span class="hl-0"> </span><span class="hl-3">all</span><span class="hl-0"> </span><span class="hl-3">scoped</span><span class="hl-0"> </span><span class="hl-3">packages</span><span class="hl-0"> </span><span class="hl-3">from</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">public</span><span class="hl-0"> </span><span class="hl-3">npm</span><span class="hl-0"> </span><span class="hl-3">registry</span>
|
|
1540
|
-
</code></pre>
|
|
1540
|
+
</code><button>Copy</button></pre>
|
|
1541
1541
|
</div><aside class="tsd-sources">
|
|
1542
1542
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scopedPackagesOptions</p></aside></section>
|
|
1543
1543
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scripts" class="tsd-anchor"></a>
|
|
@@ -1548,7 +1548,7 @@ the standard script will be overwritten.
|
|
|
1548
1548
|
Also adds the script as a task.</p>
|
|
1549
1549
|
|
|
1550
1550
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">{}</span>
|
|
1551
|
-
</code></pre>
|
|
1551
|
+
</code><button>Copy</button></pre>
|
|
1552
1552
|
|
|
1553
1553
|
<h3>Deprecated</h3><p>use <code>project.addTask()</code> or <code>package.setScript()</code></p>
|
|
1554
1554
|
</div>
|
|
@@ -1564,7 +1564,7 @@ Also adds the script as a task.</p>
|
|
|
1564
1564
|
<div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
1565
1565
|
|
|
1566
1566
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"src"</span>
|
|
1567
|
-
</code></pre>
|
|
1567
|
+
</code><button>Copy</button></pre>
|
|
1568
1568
|
</div><aside class="tsd-sources">
|
|
1569
1569
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.srcdir</p></aside></section>
|
|
1570
1570
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stability" class="tsd-anchor"></a>
|
|
@@ -1579,7 +1579,7 @@ Also adds the script as a task.</p>
|
|
|
1579
1579
|
<div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request. See <code>staleOptions</code> for options.</p>
|
|
1580
1580
|
|
|
1581
1581
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">false</span>
|
|
1582
|
-
</code></pre>
|
|
1582
|
+
</code><button>Copy</button></pre>
|
|
1583
1583
|
</div><aside class="tsd-sources">
|
|
1584
1584
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stale</p></aside></section>
|
|
1585
1585
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="staleOptions" class="tsd-anchor"></a>
|
|
@@ -1602,7 +1602,7 @@ If the test directory is outside of <code>src</code>, then we configure jest to
|
|
|
1602
1602
|
compile the code in-memory.</p>
|
|
1603
1603
|
|
|
1604
1604
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"test"</span>
|
|
1605
|
-
</code></pre>
|
|
1605
|
+
</code><button>Copy</button></pre>
|
|
1606
1606
|
</div><aside class="tsd-sources">
|
|
1607
1607
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.testdir</p></aside></section>
|
|
1608
1608
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a>
|
|
@@ -1611,7 +1611,7 @@ compile the code in-memory.</p>
|
|
|
1611
1611
|
<div class="tsd-comment tsd-typography"><p>Custom TSConfig</p>
|
|
1612
1612
|
|
|
1613
1613
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1614
|
-
</code></pre>
|
|
1614
|
+
</code><button>Copy</button></pre>
|
|
1615
1615
|
</div><aside class="tsd-sources">
|
|
1616
1616
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfig</p></aside></section>
|
|
1617
1617
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDev" class="tsd-anchor"></a>
|
|
@@ -1620,7 +1620,7 @@ compile the code in-memory.</p>
|
|
|
1620
1620
|
<div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
1621
1621
|
|
|
1622
1622
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">use</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">production</span><span class="hl-0"> </span><span class="hl-3">tsconfig</span><span class="hl-0"> </span><span class="hl-3">options</span>
|
|
1623
|
-
</code></pre>
|
|
1623
|
+
</code><button>Copy</button></pre>
|
|
1624
1624
|
</div><aside class="tsd-sources">
|
|
1625
1625
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDev</p></aside></section>
|
|
1626
1626
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDevFile" class="tsd-anchor"></a>
|
|
@@ -1629,7 +1629,7 @@ compile the code in-memory.</p>
|
|
|
1629
1629
|
<div class="tsd-comment tsd-typography"><p>The name of the development tsconfig.json file.</p>
|
|
1630
1630
|
|
|
1631
1631
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"tsconfig.dev.json"</span>
|
|
1632
|
-
</code></pre>
|
|
1632
|
+
</code><button>Copy</button></pre>
|
|
1633
1633
|
</div><aside class="tsd-sources">
|
|
1634
1634
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDevFile</p></aside></section>
|
|
1635
1635
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="typescriptVersion" class="tsd-anchor"></a>
|
|
@@ -1640,7 +1640,7 @@ compile the code in-memory.</p>
|
|
|
1640
1640
|
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
1641
1641
|
|
|
1642
1642
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"latest"</span>
|
|
1643
|
-
</code></pre>
|
|
1643
|
+
</code><button>Copy</button></pre>
|
|
1644
1644
|
</div><aside class="tsd-sources">
|
|
1645
1645
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.typescriptVersion</p></aside></section>
|
|
1646
1646
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="versionrcOptions" class="tsd-anchor"></a>
|
|
@@ -1650,7 +1650,7 @@ same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3
|
|
|
1650
1650
|
Given values either append to default configuration or overwrite values in it.</p>
|
|
1651
1651
|
|
|
1652
1652
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">standard</span><span class="hl-0"> </span><span class="hl-3">configuration</span><span class="hl-0"> </span><span class="hl-3">applicable</span><span class="hl-0"> </span><span class="hl-3">for</span><span class="hl-0"> </span><span class="hl-3">GitHub</span><span class="hl-0"> </span><span class="hl-3">repositories</span>
|
|
1653
|
-
</code></pre>
|
|
1653
|
+
</code><button>Copy</button></pre>
|
|
1654
1654
|
</div><aside class="tsd-sources">
|
|
1655
1655
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.versionrcOptions</p></aside></section>
|
|
1656
1656
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a>
|
|
@@ -1660,7 +1660,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1660
1660
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
1661
1661
|
|
|
1662
1662
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-2">true</span>
|
|
1663
|
-
</code></pre>
|
|
1663
|
+
</code><button>Copy</button></pre>
|
|
1664
1664
|
</div><aside class="tsd-sources">
|
|
1665
1665
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.vscode</p></aside></section>
|
|
1666
1666
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchExcludes" class="tsd-anchor"></a>
|
|
@@ -1669,7 +1669,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1669
1669
|
<div class="tsd-comment tsd-typography"><p>Glob patterns to exclude from <code>cdk watch</code>.</p>
|
|
1670
1670
|
|
|
1671
1671
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1672
|
-
</code></pre>
|
|
1672
|
+
</code><button>Copy</button></pre>
|
|
1673
1673
|
</div><aside class="tsd-sources">
|
|
1674
1674
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchExcludes</p></aside></section>
|
|
1675
1675
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchIncludes" class="tsd-anchor"></a>
|
|
@@ -1678,7 +1678,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1678
1678
|
<div class="tsd-comment tsd-typography"><p>Glob patterns to include in <code>cdk watch</code>.</p>
|
|
1679
1679
|
|
|
1680
1680
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[]</span>
|
|
1681
|
-
</code></pre>
|
|
1681
|
+
</code><button>Copy</button></pre>
|
|
1682
1682
|
</div><aside class="tsd-sources">
|
|
1683
1683
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchIncludes</p></aside></section>
|
|
1684
1684
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowBootstrapSteps" class="tsd-anchor"></a>
|
|
@@ -1687,7 +1687,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1687
1687
|
<div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
1688
1688
|
|
|
1689
1689
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-1">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
1690
|
-
</code></pre>
|
|
1690
|
+
</code><button>Copy</button></pre>
|
|
1691
1691
|
</div><aside class="tsd-sources">
|
|
1692
1692
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowBootstrapSteps</p></aside></section>
|
|
1693
1693
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowContainerImage" class="tsd-anchor"></a>
|
|
@@ -1696,7 +1696,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1696
1696
|
<div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
1697
1697
|
|
|
1698
1698
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-4">default</span><span class="hl-0"> </span><span class="hl-3">image</span>
|
|
1699
|
-
</code></pre>
|
|
1699
|
+
</code><button>Copy</button></pre>
|
|
1700
1700
|
</div><aside class="tsd-sources">
|
|
1701
1701
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowContainerImage</p></aside></section>
|
|
1702
1702
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowGitIdentity" class="tsd-anchor"></a>
|
|
@@ -1705,7 +1705,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1705
1705
|
<div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
1706
1706
|
|
|
1707
1707
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">GitHub</span><span class="hl-0"> </span><span class="hl-3">Actions</span>
|
|
1708
|
-
</code></pre>
|
|
1708
|
+
</code><button>Copy</button></pre>
|
|
1709
1709
|
</div><aside class="tsd-sources">
|
|
1710
1710
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowGitIdentity</p></aside></section>
|
|
1711
1711
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowNodeVersion" class="tsd-anchor"></a>
|
|
@@ -1724,7 +1724,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1724
1724
|
<div class="tsd-comment tsd-typography"><p>Github Runner selection labels</p>
|
|
1725
1725
|
|
|
1726
1726
|
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">[</span><span class="hl-1">"ubuntu-latest"</span><span class="hl-0">]</span>
|
|
1727
|
-
</code></pre>
|
|
1727
|
+
</code><button>Copy</button></pre>
|
|
1728
1728
|
</div><aside class="tsd-sources">
|
|
1729
1729
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowRunsOn</p></aside></section></section></div>
|
|
1730
1730
|
<div class="col-sidebar">
|