cdk-serverless 2.1.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +1 -0
- package/docs/constructs/assets/highlight.css +14 -14
- package/docs/constructs/assets/main.js +3 -3
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +6 -4
- package/docs/constructs/classes/AssetCdn.html +62 -55
- package/docs/constructs/classes/BaseApi.html +54 -46
- package/docs/constructs/classes/CognitoAuthentication.html +64 -56
- package/docs/constructs/classes/GraphQlApi.html +384 -0
- package/docs/constructs/classes/LambdaFunction.html +433 -367
- package/docs/constructs/classes/RestApi.html +110 -97
- package/docs/constructs/classes/SingleTableDatastore.html +56 -49
- package/docs/constructs/classes/Workflow.html +62 -55
- package/docs/constructs/index.html +26 -23
- package/docs/constructs/interfaces/AssetCdnProps.html +35 -30
- package/docs/constructs/interfaces/BaseApiProps.html +73 -61
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +61 -48
- package/docs/constructs/interfaces/GraphQlApiProps.html +205 -0
- package/docs/constructs/interfaces/ICognitoAuthentication.html +30 -26
- package/docs/constructs/interfaces/IJwtAuthentication.html +40 -34
- package/docs/constructs/interfaces/LambdaFunctionProps.html +97 -80
- package/docs/constructs/interfaces/LambdaTracingOptions.html +31 -27
- package/docs/constructs/interfaces/RestApiProps.html +108 -92
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +44 -38
- package/docs/constructs/interfaces/SingleTableDesign.html +46 -39
- package/docs/constructs/interfaces/VtlResolverOptions.html +102 -0
- package/docs/constructs/interfaces/WorkflowProps.html +40 -37
- package/docs/constructs/modules.html +46 -40
- package/docs/constructs/types/LambdaOptions.html +24 -21
- package/docs/lambda/assets/highlight.css +11 -4
- package/docs/lambda/assets/main.js +3 -3
- package/docs/lambda/assets/style.css +6 -4
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +113 -120
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +108 -116
- package/docs/lambda/classes/auth.JwtAuthorizer.html +108 -116
- package/docs/lambda/classes/errors.BadRequestError.html +43 -67
- package/docs/lambda/classes/errors.ForbiddenError.html +43 -67
- package/docs/lambda/classes/errors.HttpError.html +43 -67
- package/docs/lambda/classes/errors.NotFoundError.html +43 -67
- package/docs/lambda/classes/errors.UnauthenticatedError.html +43 -67
- package/docs/lambda/functions/api.createAppSyncHandler.html +23 -39
- package/docs/lambda/functions/api.createHttpHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +21 -38
- package/docs/lambda/index.html +7 -41
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +33 -50
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +36 -53
- package/docs/lambda/interfaces/api.HttpResponseContext.html +30 -47
- package/docs/lambda/interfaces/api.Operation.html +24 -41
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +27 -44
- package/docs/lambda/modules/api.html +31 -49
- package/docs/lambda/modules/auth.html +19 -43
- package/docs/lambda/modules/errors.html +15 -41
- package/docs/lambda/modules.html +8 -42
- package/docs/lambda/types/api.APIGatewayv1Handler.html +20 -37
- package/docs/lambda/types/api.AppSyncHandler.html +20 -37
- package/docs/lambda/types/api.HttpHandler.html +20 -37
- package/docs/projen/assets/highlight.css +25 -18
- package/docs/projen/assets/main.js +3 -3
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +6 -4
- package/docs/projen/classes/Datastore.html +54 -49
- package/docs/projen/classes/GraphQlApi.html +155 -0
- package/docs/projen/classes/RestApi.html +54 -49
- package/docs/projen/classes/ServerlessProject.html +590 -461
- package/docs/projen/classes/Workflow.html +54 -49
- package/docs/projen/index.html +15 -13
- package/docs/projen/interfaces/DatastoreOptions.html +20 -18
- package/docs/projen/interfaces/GraphQlApiOptions.html +77 -0
- package/docs/projen/interfaces/RestApiOptions.html +20 -18
- package/docs/projen/interfaces/ServerlessProjectOptions.html +979 -808
- package/docs/projen/interfaces/WorkflowOptions.html +20 -18
- package/docs/projen/modules.html +24 -20
- package/docs/projen/variables/PACKAGE_NAME.html +13 -11
- package/lib/constructs/graphql.d.ts +52 -0
- package/lib/constructs/graphql.js +310 -0
- package/lib/constructs/index.d.ts +1 -0
- package/lib/constructs/index.js +2 -1
- package/lib/projen/core.js +1 -2
- package/lib/projen/datastore.js +3 -4
- package/lib/projen/graphql.d.ts +10 -0
- package/lib/projen/graphql.js +90 -0
- package/lib/projen/index.d.ts +1 -0
- package/lib/projen/index.js +2 -2
- package/lib/projen/rest-api.js +3 -1
- package/package.json +8 -8
|
@@ -28,120 +28,123 @@
|
|
|
28
28
|
<div class="tsd-accordion-details">
|
|
29
29
|
<section class="tsd-index-section">
|
|
30
30
|
<h3 class="tsd-index-heading">Constructors</h3>
|
|
31
|
-
<div class="tsd-index-list"><a href="ServerlessProject.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
31
|
+
<div class="tsd-index-list"><a href="ServerlessProject.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
|
|
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="ServerlessProject.html#appEntrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
36
|
-
<a href="ServerlessProject.html#artifactsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
37
|
-
<a href="ServerlessProject.html#artifactsJavascriptDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
38
|
-
<a href="ServerlessProject.html#autoApprove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
39
|
-
<a href="ServerlessProject.html#autoMerge" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
40
|
-
<a href="ServerlessProject.html#buildWorkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
41
|
-
<a href="ServerlessProject.html#bundler" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
42
|
-
<a href="ServerlessProject.html#cdkConfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
43
|
-
<a href="ServerlessProject.html#cdkDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
44
|
-
<a href="ServerlessProject.html#cdkTasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
45
|
-
<a href="ServerlessProject.html#commitGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
46
|
-
<a href="ServerlessProject.html#defaultTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
47
|
-
<a href="ServerlessProject.html#deps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
48
|
-
<a href="ServerlessProject.html#devContainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
49
|
-
<a href="ServerlessProject.html#docgen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
50
|
-
<a href="ServerlessProject.html#docsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
51
|
-
<a href="ServerlessProject.html#eslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
52
|
-
<a href="ServerlessProject.html#gitattributes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
53
|
-
<a href="ServerlessProject.html#github" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
54
|
-
<a href="ServerlessProject.html#gitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
55
|
-
<a href="ServerlessProject.html#gitpod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
56
|
-
<a href="ServerlessProject.html#initProject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
57
|
-
<a href="ServerlessProject.html#jest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
58
|
-
<a href="ServerlessProject.html#libdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
59
|
-
<a href="ServerlessProject.html#logger" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
60
|
-
<a href="ServerlessProject.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
61
|
-
<a href="ServerlessProject.html#nodeVersion" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
62
|
-
<a href="ServerlessProject.html#npmignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
63
|
-
<a href="ServerlessProject.html#
|
|
64
|
-
<a href="ServerlessProject.html#
|
|
65
|
-
<a href="ServerlessProject.html#
|
|
66
|
-
<a href="ServerlessProject.html#
|
|
67
|
-
<a href="ServerlessProject.html#
|
|
68
|
-
<a href="ServerlessProject.html#
|
|
69
|
-
<a href="ServerlessProject.html#
|
|
70
|
-
<a href="ServerlessProject.html#
|
|
71
|
-
<a href="ServerlessProject.html#
|
|
72
|
-
<a href="ServerlessProject.html#
|
|
73
|
-
<a href="ServerlessProject.html#
|
|
74
|
-
<a href="ServerlessProject.html#
|
|
75
|
-
<a href="ServerlessProject.html#
|
|
76
|
-
<a href="ServerlessProject.html#
|
|
77
|
-
<a href="ServerlessProject.html#
|
|
78
|
-
<a href="ServerlessProject.html#
|
|
79
|
-
<a href="ServerlessProject.html#
|
|
80
|
-
<a href="ServerlessProject.html#
|
|
81
|
-
<a href="ServerlessProject.html#
|
|
82
|
-
<a href="ServerlessProject.html#
|
|
83
|
-
<a href="ServerlessProject.html#
|
|
84
|
-
<a href="ServerlessProject.html#
|
|
35
|
+
<div class="tsd-index-list"><a href="ServerlessProject.html#appEntrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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>app<wbr/>Entrypoint</span></a>
|
|
36
|
+
<a href="ServerlessProject.html#artifactsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a>
|
|
37
|
+
<a href="ServerlessProject.html#artifactsJavascriptDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a>
|
|
38
|
+
<a href="ServerlessProject.html#autoApprove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Approve?</span></a>
|
|
39
|
+
<a href="ServerlessProject.html#autoMerge" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Merge?</span></a>
|
|
40
|
+
<a href="ServerlessProject.html#buildWorkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>build<wbr/>Workflow?</span></a>
|
|
41
|
+
<a href="ServerlessProject.html#bundler" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bundler</span></a>
|
|
42
|
+
<a href="ServerlessProject.html#cdkConfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Config</span></a>
|
|
43
|
+
<a href="ServerlessProject.html#cdkDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Deps</span></a>
|
|
44
|
+
<a href="ServerlessProject.html#cdkTasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Tasks</span></a>
|
|
45
|
+
<a href="ServerlessProject.html#commitGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a>
|
|
46
|
+
<a href="ServerlessProject.html#defaultTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Task?</span></a>
|
|
47
|
+
<a href="ServerlessProject.html#deps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>deps</span></a>
|
|
48
|
+
<a href="ServerlessProject.html#devContainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dev<wbr/>Container</span></a>
|
|
49
|
+
<a href="ServerlessProject.html#docgen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>docgen?</span></a>
|
|
50
|
+
<a href="ServerlessProject.html#docsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a>
|
|
51
|
+
<a href="ServerlessProject.html#eslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>eslint?</span></a>
|
|
52
|
+
<a href="ServerlessProject.html#gitattributes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitattributes</span></a>
|
|
53
|
+
<a href="ServerlessProject.html#github" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>github</span></a>
|
|
54
|
+
<a href="ServerlessProject.html#gitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitignore</span></a>
|
|
55
|
+
<a href="ServerlessProject.html#gitpod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitpod</span></a>
|
|
56
|
+
<a href="ServerlessProject.html#initProject" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>init<wbr/>Project?</span></a>
|
|
57
|
+
<a href="ServerlessProject.html#jest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>jest?</span></a>
|
|
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
|
+
<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
|
+
<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#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
|
+
<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
|
+
<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
|
+
<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
|
+
<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>
|
|
67
|
+
<a href="ServerlessProject.html#prettier" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prettier?</span></a>
|
|
68
|
+
<a href="ServerlessProject.html#projectBuild" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project<wbr/>Build</span></a>
|
|
69
|
+
<a href="ServerlessProject.html#projectType" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project<wbr/>Type</span></a>
|
|
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
|
+
<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
|
+
<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
|
+
<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
|
+
<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
|
+
<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>
|
|
77
|
+
<a href="ServerlessProject.html#testdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>testdir</span></a>
|
|
78
|
+
<a href="ServerlessProject.html#tsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig?</span></a>
|
|
79
|
+
<a href="ServerlessProject.html#tsconfigDev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a>
|
|
80
|
+
<a href="ServerlessProject.html#tsconfigEslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig<wbr/>Eslint?</span></a>
|
|
81
|
+
<a href="ServerlessProject.html#upgradeWorkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>upgrade<wbr/>Workflow?</span></a>
|
|
82
|
+
<a href="ServerlessProject.html#vscode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>vscode</span></a>
|
|
83
|
+
<a href="ServerlessProject.html#watchTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>watch<wbr/>Task</span></a>
|
|
84
|
+
<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
|
+
<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
|
+
<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>
|
|
85
87
|
</div></section>
|
|
86
88
|
<section class="tsd-index-section">
|
|
87
89
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
88
|
-
<div class="tsd-index-list"><a href="ServerlessProject.html#allowLibraryDependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
89
|
-
<a href="ServerlessProject.html#buildTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
90
|
-
<a href="ServerlessProject.html#buildWorkflowJobId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
91
|
-
<a href="ServerlessProject.html#cdkVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
92
|
-
<a href="ServerlessProject.html#compileTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
93
|
-
<a href="ServerlessProject.html#components" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
94
|
-
<a href="ServerlessProject.html#ejected" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
95
|
-
<a href="ServerlessProject.html#entrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
96
|
-
<a href="ServerlessProject.html#files" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
97
|
-
<a href="ServerlessProject.html#manifest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
98
|
-
<a href="ServerlessProject.html#maxNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
99
|
-
<a href="ServerlessProject.html#minNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
100
|
-
<a href="ServerlessProject.html#packageManager" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
101
|
-
<a href="ServerlessProject.html#packageTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
102
|
-
<a href="ServerlessProject.html#postCompileTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
103
|
-
<a href="ServerlessProject.html#preCompileTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
104
|
-
<a href="ServerlessProject.html#
|
|
90
|
+
<div class="tsd-index-list"><a href="ServerlessProject.html#allowLibraryDependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a>
|
|
91
|
+
<a href="ServerlessProject.html#buildTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>build<wbr/>Task</span></a>
|
|
92
|
+
<a href="ServerlessProject.html#buildWorkflowJobId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span></a>
|
|
93
|
+
<a href="ServerlessProject.html#cdkVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a>
|
|
94
|
+
<a href="ServerlessProject.html#compileTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>compile<wbr/>Task</span></a>
|
|
95
|
+
<a href="ServerlessProject.html#components" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>components</span></a>
|
|
96
|
+
<a href="ServerlessProject.html#ejected" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ejected</span></a>
|
|
97
|
+
<a href="ServerlessProject.html#entrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>entrypoint</span></a>
|
|
98
|
+
<a href="ServerlessProject.html#files" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>files</span></a>
|
|
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
|
+
<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
|
+
<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#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
|
+
<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
|
+
<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
|
+
<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>
|
|
106
|
+
<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
|
+
<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>
|
|
105
108
|
</div></section>
|
|
106
109
|
<section class="tsd-index-section">
|
|
107
110
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
108
|
-
<div class="tsd-index-list"><a href="ServerlessProject.html#addBins" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
109
|
-
<a href="ServerlessProject.html#addBundledDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
110
|
-
<a href="ServerlessProject.html#addCdkDependency" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
111
|
-
<a href="ServerlessProject.html#addCompileCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
112
|
-
<a href="ServerlessProject.html#addDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
113
|
-
<a href="ServerlessProject.html#addDevDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
114
|
-
<a href="ServerlessProject.html#addExcludeFromCleanup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
115
|
-
<a href="ServerlessProject.html#addFields" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
116
|
-
<a href="ServerlessProject.html#addGitIgnore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
117
|
-
<a href="ServerlessProject.html#addKeywords" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
118
|
-
<a href="ServerlessProject.html#addPackageIgnore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
119
|
-
<a href="ServerlessProject.html#addPeerDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
120
|
-
<a href="ServerlessProject.html#addScripts" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
121
|
-
<a href="ServerlessProject.html#addTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
122
|
-
<a href="ServerlessProject.html#addTestCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
123
|
-
<a href="ServerlessProject.html#addTip" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
124
|
-
<a href="ServerlessProject.html#annotateGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
125
|
-
<a href="ServerlessProject.html#hasScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
126
|
-
<a href="ServerlessProject.html#postSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
127
|
-
<a href="ServerlessProject.html#preSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
128
|
-
<a href="ServerlessProject.html#removeScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
129
|
-
<a href="ServerlessProject.html#removeTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
130
|
-
<a href="ServerlessProject.html#renderWorkflowSetup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
131
|
-
<a href="ServerlessProject.html#runTaskCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
132
|
-
<a href="ServerlessProject.html#setScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
133
|
-
<a href="ServerlessProject.html#synth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
134
|
-
<a href="ServerlessProject.html#tryFindFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
135
|
-
<a href="ServerlessProject.html#tryFindJsonFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
136
|
-
<a href="ServerlessProject.html#tryFindObjectFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
137
|
-
<a href="ServerlessProject.html#tryRemoveFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
111
|
+
<div class="tsd-index-list"><a href="ServerlessProject.html#addBins" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>add<wbr/>Bins</span></a>
|
|
112
|
+
<a href="ServerlessProject.html#addBundledDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a>
|
|
113
|
+
<a href="ServerlessProject.html#addCdkDependency" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Cdk<wbr/>Dependency</span></a>
|
|
114
|
+
<a href="ServerlessProject.html#addCompileCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Compile<wbr/>Command</span></a>
|
|
115
|
+
<a href="ServerlessProject.html#addDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Deps</span></a>
|
|
116
|
+
<a href="ServerlessProject.html#addDevDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a>
|
|
117
|
+
<a href="ServerlessProject.html#addExcludeFromCleanup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a>
|
|
118
|
+
<a href="ServerlessProject.html#addFields" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Fields</span></a>
|
|
119
|
+
<a href="ServerlessProject.html#addGitIgnore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Git<wbr/>Ignore</span></a>
|
|
120
|
+
<a href="ServerlessProject.html#addKeywords" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Keywords</span></a>
|
|
121
|
+
<a href="ServerlessProject.html#addPackageIgnore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Package<wbr/>Ignore</span></a>
|
|
122
|
+
<a href="ServerlessProject.html#addPeerDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a>
|
|
123
|
+
<a href="ServerlessProject.html#addScripts" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a>
|
|
124
|
+
<a href="ServerlessProject.html#addTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task</span></a>
|
|
125
|
+
<a href="ServerlessProject.html#addTestCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a>
|
|
126
|
+
<a href="ServerlessProject.html#addTip" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Tip</span></a>
|
|
127
|
+
<a href="ServerlessProject.html#annotateGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a>
|
|
128
|
+
<a href="ServerlessProject.html#hasScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Script</span></a>
|
|
129
|
+
<a href="ServerlessProject.html#postSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a>
|
|
130
|
+
<a href="ServerlessProject.html#preSynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a>
|
|
131
|
+
<a href="ServerlessProject.html#removeScript" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Script</span></a>
|
|
132
|
+
<a href="ServerlessProject.html#removeTask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task</span></a>
|
|
133
|
+
<a href="ServerlessProject.html#renderWorkflowSetup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a>
|
|
134
|
+
<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
|
+
<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
|
+
<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>
|
|
137
|
+
<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
|
+
<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
|
+
<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
|
+
<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>
|
|
138
141
|
</div></section></div></details></section></section>
|
|
139
142
|
<section class="tsd-panel-group tsd-member-group">
|
|
140
143
|
<h2>Constructors</h2>
|
|
141
144
|
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
142
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
145
|
+
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
143
146
|
<ul class="tsd-signatures">
|
|
144
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_ServerlessProject"><span class="tsd-kind-constructor-signature">new <wbr/>Serverless<wbr/>Project</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ServerlessProject.html" class="tsd-signature-type tsd-kind-class">ServerlessProject</a><a href="#constructor.new_ServerlessProject" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
147
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_ServerlessProject"><span class="tsd-kind-constructor-signature">new <wbr/>Serverless<wbr/>Project</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ServerlessProject.html" class="tsd-signature-type tsd-kind-class">ServerlessProject</a><a href="#constructor.new_ServerlessProject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
145
148
|
<li class="tsd-description">
|
|
146
149
|
<div class="tsd-parameters">
|
|
147
150
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -153,439 +156,507 @@
|
|
|
153
156
|
<section class="tsd-panel-group tsd-member-group">
|
|
154
157
|
<h2>Properties</h2>
|
|
155
158
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appEntrypoint" class="tsd-anchor"></a>
|
|
156
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>app<wbr/>Entrypoint</span><a href="#appEntrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
159
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>app<wbr/>Entrypoint</span><a href="#appEntrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
157
160
|
<div class="tsd-signature"><span class="tsd-kind-property">app<wbr/>Entrypoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
158
161
|
<div class="tsd-comment tsd-typography"><p>The CDK app entrypoint</p>
|
|
159
|
-
</div
|
|
162
|
+
</div>
|
|
163
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
160
164
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.appEntrypoint</p></aside></section>
|
|
161
165
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsDirectory" class="tsd-anchor"></a>
|
|
162
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Directory</span><a href="#artifactsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
166
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Directory</span><a href="#artifactsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
163
167
|
<div class="tsd-signature"><span class="tsd-kind-property">artifacts<wbr/>Directory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
168
|
<div class="tsd-comment tsd-typography"><p>The build output directory. An npm tarball will be created under the <code>js</code>
|
|
165
169
|
subdirectory. For example, if this is set to <code>dist</code> (the default), the npm
|
|
166
170
|
tarball will be placed under <code>dist/js/boom-boom-1.2.3.tg</code>.</p>
|
|
167
|
-
</div
|
|
171
|
+
</div>
|
|
172
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
168
173
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsDirectory</p></aside></section>
|
|
169
174
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsJavascriptDirectory" class="tsd-anchor"></a>
|
|
170
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Javascript<wbr/>Directory</span><a href="#artifactsJavascriptDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
175
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Javascript<wbr/>Directory</span><a href="#artifactsJavascriptDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
171
176
|
<div class="tsd-signature"><span class="tsd-kind-property">artifacts<wbr/>Javascript<wbr/>Directory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
172
177
|
<div class="tsd-comment tsd-typography"><p>The location of the npm tarball after build (<code>${artifactsDirectory}/js</code>).</p>
|
|
173
|
-
</div
|
|
178
|
+
</div>
|
|
179
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
174
180
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.artifactsJavascriptDirectory</p></aside></section>
|
|
175
181
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApprove" class="tsd-anchor"></a>
|
|
176
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Approve</span><a href="#autoApprove" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
182
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Approve</span><a href="#autoApprove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
177
183
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Approve</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoApprove</span></div>
|
|
178
184
|
<div class="tsd-comment tsd-typography"><p>Auto approve set up for this project.</p>
|
|
179
|
-
</div
|
|
185
|
+
</div>
|
|
186
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
180
187
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoApprove</p></aside></section>
|
|
181
188
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMerge" class="tsd-anchor"></a>
|
|
182
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Merge</span><a href="#autoMerge" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
189
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Merge</span><a href="#autoMerge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
183
190
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Merge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoMerge</span></div>
|
|
184
191
|
<div class="tsd-comment tsd-typography"><p>Component that sets up mergify for merging approved pull requests.</p>
|
|
185
|
-
</div
|
|
192
|
+
</div>
|
|
193
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
186
194
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.autoMerge</p></aside></section>
|
|
187
195
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflow" class="tsd-anchor"></a>
|
|
188
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Workflow</span><a href="#buildWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
196
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Workflow</span><a href="#buildWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
189
197
|
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">BuildWorkflow</span></div>
|
|
190
198
|
<div class="tsd-comment tsd-typography"><p>The PR build GitHub workflow. <code>undefined</code> if <code>buildWorkflow</code> is disabled.</p>
|
|
191
|
-
</div
|
|
199
|
+
</div>
|
|
200
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
192
201
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflow</p></aside></section>
|
|
193
202
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundler" class="tsd-anchor"></a>
|
|
194
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundler</span><a href="#bundler" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
203
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundler</span><a href="#bundler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
195
204
|
<div class="tsd-signature"><span class="tsd-kind-property">bundler</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Bundler</span></div><aside class="tsd-sources">
|
|
196
205
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.bundler</p></aside></section>
|
|
197
206
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkConfig" class="tsd-anchor"></a>
|
|
198
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Config</span><a href="#cdkConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
207
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Config</span><a href="#cdkConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
199
208
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">CdkConfig</span></div>
|
|
200
209
|
<div class="tsd-comment tsd-typography"><p>cdk.json configuration.</p>
|
|
201
|
-
</div
|
|
210
|
+
</div>
|
|
211
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
202
212
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkConfig</p></aside></section>
|
|
203
213
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDeps" class="tsd-anchor"></a>
|
|
204
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Deps</span><a href="#cdkDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
214
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Deps</span><a href="#cdkDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
205
215
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">AwsCdkDeps</span></div><aside class="tsd-sources">
|
|
206
216
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkDeps</p></aside></section>
|
|
207
217
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkTasks" class="tsd-anchor"></a>
|
|
208
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Tasks</span><a href="#cdkTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
218
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Tasks</span><a href="#cdkTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
209
219
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">CdkTasks</span></div>
|
|
210
220
|
<div class="tsd-comment tsd-typography"><p>Common CDK tasks.</p>
|
|
211
|
-
</div
|
|
221
|
+
</div>
|
|
222
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
212
223
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkTasks</p></aside></section>
|
|
213
224
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitGenerated" class="tsd-anchor"></a>
|
|
214
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>commit<wbr/>Generated</span><a href="#commitGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
225
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>commit<wbr/>Generated</span><a href="#commitGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
215
226
|
<div class="tsd-signature"><span class="tsd-kind-property">commit<wbr/>Generated</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
216
227
|
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
217
|
-
</div
|
|
228
|
+
</div>
|
|
229
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
218
230
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.commitGenerated</p></aside></section>
|
|
219
231
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultTask" class="tsd-anchor"></a>
|
|
220
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>default<wbr/>Task</span><a href="#defaultTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
232
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>default<wbr/>Task</span><a href="#defaultTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
221
233
|
<div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Task</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Task</span></div>
|
|
222
234
|
<div class="tsd-comment tsd-typography"><p>This is the "default" task, the one that executes "projen". Undefined if
|
|
223
235
|
the project is being ejected.</p>
|
|
224
|
-
</div
|
|
236
|
+
</div>
|
|
237
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
225
238
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.defaultTask</p></aside></section>
|
|
226
239
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a>
|
|
227
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps</span><a href="#deps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
240
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps</span><a href="#deps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
228
241
|
<div class="tsd-signature"><span class="tsd-kind-property">deps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Dependencies</span></div>
|
|
229
242
|
<div class="tsd-comment tsd-typography"><p>Project dependencies.</p>
|
|
230
|
-
</div
|
|
243
|
+
</div>
|
|
244
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
231
245
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.deps</p></aside></section>
|
|
232
246
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devContainer" class="tsd-anchor"></a>
|
|
233
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Container</span><a href="#devContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
247
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Container</span><a href="#devContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
234
248
|
<div class="tsd-signature"><span class="tsd-kind-property">dev<wbr/>Container</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">DevContainer</span></div>
|
|
235
249
|
<div class="tsd-comment tsd-typography"><p>Access for .devcontainer.json (used for GitHub Codespaces)</p>
|
|
236
250
|
<p>This will be <code>undefined</code> if devContainer boolean is false</p>
|
|
237
|
-
</div
|
|
251
|
+
</div>
|
|
252
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
238
253
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.devContainer</p></aside></section>
|
|
239
254
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a>
|
|
240
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docgen</span><a href="#docgen" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
255
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docgen</span><a href="#docgen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
241
256
|
<div class="tsd-signature"><span class="tsd-kind-property">docgen</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
242
257
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docgen</p></aside></section>
|
|
243
258
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsDirectory" class="tsd-anchor"></a>
|
|
244
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docs<wbr/>Directory</span><a href="#docsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
259
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docs<wbr/>Directory</span><a href="#docsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
245
260
|
<div class="tsd-signature"><span class="tsd-kind-property">docs<wbr/>Directory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
246
261
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.docsDirectory</p></aside></section>
|
|
247
262
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a>
|
|
248
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint</span><a href="#eslint" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
263
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint</span><a href="#eslint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
249
264
|
<div class="tsd-signature"><span class="tsd-kind-property">eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Eslint</span></div><aside class="tsd-sources">
|
|
250
265
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.eslint</p></aside></section>
|
|
251
266
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitattributes" class="tsd-anchor"></a>
|
|
252
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitattributes</span><a href="#gitattributes" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
267
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitattributes</span><a href="#gitattributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
253
268
|
<div class="tsd-signature"><span class="tsd-kind-property">gitattributes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">GitAttributesFile</span></div>
|
|
254
269
|
<div class="tsd-comment tsd-typography"><p>The .gitattributes file for this repository.</p>
|
|
255
|
-
</div
|
|
270
|
+
</div>
|
|
271
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
256
272
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitattributes</p></aside></section>
|
|
257
273
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="github" class="tsd-anchor"></a>
|
|
258
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github</span><a href="#github" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
274
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github</span><a href="#github" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
259
275
|
<div class="tsd-signature"><span class="tsd-kind-property">github</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">GitHub</span></div>
|
|
260
276
|
<div class="tsd-comment tsd-typography"><p>Access all github components.</p>
|
|
261
277
|
<p>This will be <code>undefined</code> for subprojects.</p>
|
|
262
|
-
</div
|
|
278
|
+
</div>
|
|
279
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
263
280
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.github</p></aside></section>
|
|
264
281
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a>
|
|
265
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitignore</span><a href="#gitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
282
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitignore</span><a href="#gitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
266
283
|
<div class="tsd-signature"><span class="tsd-kind-property">gitignore</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">IgnoreFile</span></div>
|
|
267
284
|
<div class="tsd-comment tsd-typography"><p>.gitignore</p>
|
|
268
|
-
</div
|
|
285
|
+
</div>
|
|
286
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
269
287
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitignore</p></aside></section>
|
|
270
288
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitpod" class="tsd-anchor"></a>
|
|
271
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitpod</span><a href="#gitpod" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
289
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitpod</span><a href="#gitpod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
272
290
|
<div class="tsd-signature"><span class="tsd-kind-property">gitpod</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Gitpod</span></div>
|
|
273
291
|
<div class="tsd-comment tsd-typography"><p>Access for Gitpod</p>
|
|
274
292
|
<p>This will be <code>undefined</code> if gitpod boolean is false</p>
|
|
275
|
-
</div
|
|
293
|
+
</div>
|
|
294
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
276
295
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.gitpod</p></aside></section>
|
|
277
296
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="initProject" class="tsd-anchor"></a>
|
|
278
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>init<wbr/>Project</span><a href="#initProject" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
297
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>init<wbr/>Project</span><a href="#initProject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
279
298
|
<div class="tsd-signature"><span class="tsd-kind-property">init<wbr/>Project</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">InitProject</span></div>
|
|
280
299
|
<div class="tsd-comment tsd-typography"><p>The options used when this project is bootstrapped via <code>projen new</code>. It
|
|
281
300
|
includes the original set of options passed to the CLI and also the JSII
|
|
282
301
|
FQN of the project type.</p>
|
|
283
|
-
</div
|
|
302
|
+
</div>
|
|
303
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
284
304
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.initProject</p></aside></section>
|
|
285
305
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jest" class="tsd-anchor"></a>
|
|
286
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jest</span><a href="#jest" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
306
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jest</span><a href="#jest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
287
307
|
<div class="tsd-signature"><span class="tsd-kind-property">jest</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Jest</span></div>
|
|
288
308
|
<div class="tsd-comment tsd-typography"><p>The Jest configuration (if enabled)</p>
|
|
289
|
-
</div
|
|
309
|
+
</div>
|
|
310
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
290
311
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.jest</p></aside></section>
|
|
291
312
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="libdir" class="tsd-anchor"></a>
|
|
292
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
313
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
293
314
|
<div class="tsd-signature"><span class="tsd-kind-property">libdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
294
315
|
<div class="tsd-comment tsd-typography"><p>The directory in which compiled .js files reside.</p>
|
|
295
|
-
</div
|
|
316
|
+
</div>
|
|
317
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
296
318
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.libdir</p></aside></section>
|
|
297
319
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logger" class="tsd-anchor"></a>
|
|
298
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
320
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
299
321
|
<div class="tsd-signature"><span class="tsd-kind-property">logger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Logger</span></div>
|
|
300
322
|
<div class="tsd-comment tsd-typography"><p>Logging utilities.</p>
|
|
301
|
-
</div
|
|
323
|
+
</div>
|
|
324
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
302
325
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.logger</p></aside></section>
|
|
303
326
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
|
|
304
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
327
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
305
328
|
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
306
329
|
<div class="tsd-comment tsd-typography"><p>Project name.</p>
|
|
307
|
-
</div
|
|
330
|
+
</div>
|
|
331
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
308
332
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.name</p></aside></section>
|
|
309
333
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="nodeVersion" class="tsd-anchor"></a>
|
|
310
|
-
<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
|
|
334
|
+
<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>
|
|
311
335
|
<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">
|
|
312
336
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.nodeVersion</p></aside></section>
|
|
313
337
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a>
|
|
314
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npmignore</span><a href="#npmignore" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
338
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npmignore</span><a href="#npmignore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
315
339
|
<div class="tsd-signature"><span class="tsd-kind-property">npmignore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IgnoreFile</span></div>
|
|
316
340
|
<div class="tsd-comment tsd-typography"><p>The .npmignore file.</p>
|
|
317
|
-
</div
|
|
341
|
+
</div>
|
|
342
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
318
343
|
<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>
|
|
319
351
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
320
|
-
<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
|
|
352
|
+
<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>
|
|
321
353
|
<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>
|
|
322
354
|
<div class="tsd-comment tsd-typography"><p>Absolute output directory of this project.</p>
|
|
323
|
-
</div
|
|
355
|
+
</div>
|
|
356
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
324
357
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.outdir</p></aside></section>
|
|
325
358
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a>
|
|
326
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
359
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
327
360
|
<div class="tsd-signature"><span class="tsd-kind-property">package</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">NodePackage</span></div>
|
|
328
361
|
<div class="tsd-comment tsd-typography"><p>API for managing the node package.</p>
|
|
329
|
-
</div
|
|
362
|
+
</div>
|
|
363
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
330
364
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.package</p></aside></section>
|
|
331
365
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="parent" class="tsd-anchor"></a>
|
|
332
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
366
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
333
367
|
<div class="tsd-signature"><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Project</span></div>
|
|
334
368
|
<div class="tsd-comment tsd-typography"><p>A parent project. If undefined, this is the root project.</p>
|
|
335
|
-
</div
|
|
369
|
+
</div>
|
|
370
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
336
371
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.parent</p></aside></section>
|
|
337
372
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" class="tsd-anchor"></a>
|
|
338
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier</span><a href="#prettier" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
373
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier</span><a href="#prettier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
339
374
|
<div class="tsd-signature"><span class="tsd-kind-property">prettier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Prettier</span></div><aside class="tsd-sources">
|
|
340
375
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.prettier</p></aside></section>
|
|
341
376
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectBuild" class="tsd-anchor"></a>
|
|
342
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project<wbr/>Build</span><a href="#projectBuild" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
377
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project<wbr/>Build</span><a href="#projectBuild" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
343
378
|
<div class="tsd-signature"><span class="tsd-kind-property">project<wbr/>Build</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ProjectBuild</span></div>
|
|
344
379
|
<div class="tsd-comment tsd-typography"><p>Manages the build process of the project.</p>
|
|
345
|
-
</div
|
|
380
|
+
</div>
|
|
381
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
346
382
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectBuild</p></aside></section>
|
|
347
383
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectType" class="tsd-anchor"></a>
|
|
348
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project<wbr/>Type</span><a href="#projectType" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
384
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>project<wbr/>Type</span><a href="#projectType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
349
385
|
<div class="tsd-signature"><span class="tsd-kind-property">project<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ProjectType</span></div><aside class="tsd-sources">
|
|
350
386
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projectType</p></aside></section>
|
|
351
387
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCommand" class="tsd-anchor"></a>
|
|
352
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Command</span><a href="#projenCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
388
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Command</span><a href="#projenCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
353
389
|
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
354
390
|
<div class="tsd-comment tsd-typography"><p>The command to use in order to run the projen CLI.</p>
|
|
355
|
-
</div
|
|
391
|
+
</div>
|
|
392
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
356
393
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.projenCommand</p></aside></section>
|
|
357
394
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publisher" class="tsd-anchor"></a>
|
|
358
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">publisher</span><a href="#publisher" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
395
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">publisher</span><a href="#publisher" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
359
396
|
<div class="tsd-signature"><span class="tsd-kind-property">publisher</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Publisher</span></div>
|
|
360
397
|
<div class="tsd-comment tsd-typography"><p>Package publisher. This will be <code>undefined</code> if the project does not have a
|
|
361
398
|
release workflow.</p>
|
|
362
|
-
|
|
363
|
-
<
|
|
399
|
+
</div>
|
|
400
|
+
<div class="tsd-comment tsd-typography">
|
|
401
|
+
<h4>Deprecated</h4><p>use <code>release.publisher</code>.</p>
|
|
364
402
|
</div><aside class="tsd-sources">
|
|
365
403
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.publisher</p></aside></section>
|
|
366
404
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a>
|
|
367
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
405
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
368
406
|
<div class="tsd-signature"><span class="tsd-kind-property">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Release</span></div>
|
|
369
407
|
<div class="tsd-comment tsd-typography"><p>Release management.</p>
|
|
370
|
-
</div
|
|
408
|
+
</div>
|
|
409
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
371
410
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.release</p></aside></section>
|
|
372
411
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="root" class="tsd-anchor"></a>
|
|
373
|
-
<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
|
|
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>
|
|
374
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>
|
|
375
414
|
<div class="tsd-comment tsd-typography"><p>The root project.</p>
|
|
376
|
-
</div
|
|
415
|
+
</div>
|
|
416
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
377
417
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.root</p></aside></section>
|
|
378
418
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runScriptCommand" class="tsd-anchor"></a>
|
|
379
|
-
<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
|
|
419
|
+
<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>
|
|
380
420
|
<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>
|
|
381
421
|
<div class="tsd-comment tsd-typography"><p>The command to use to run scripts (e.g. <code>yarn run</code> or <code>npm run</code> depends on the package manager).</p>
|
|
382
|
-
</div
|
|
422
|
+
</div>
|
|
423
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
383
424
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runScriptCommand</p></aside></section>
|
|
384
425
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="srcdir" class="tsd-anchor"></a>
|
|
385
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
426
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
386
427
|
<div class="tsd-signature"><span class="tsd-kind-property">srcdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
387
428
|
<div class="tsd-comment tsd-typography"><p>The directory in which the .ts sources reside.</p>
|
|
388
|
-
</div
|
|
429
|
+
</div>
|
|
430
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
389
431
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.srcdir</p></aside></section>
|
|
390
432
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tasks" class="tsd-anchor"></a>
|
|
391
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tasks</span><a href="#tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
433
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tasks</span><a href="#tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
392
434
|
<div class="tsd-signature"><span class="tsd-kind-property">tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Tasks</span></div>
|
|
393
435
|
<div class="tsd-comment tsd-typography"><p>Project tasks.</p>
|
|
394
|
-
</div
|
|
436
|
+
</div>
|
|
437
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
395
438
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tasks</p></aside></section>
|
|
396
439
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testdir" class="tsd-anchor"></a>
|
|
397
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>testdir</span><a href="#testdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
440
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>testdir</span><a href="#testdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
398
441
|
<div class="tsd-signature"><span class="tsd-kind-property">testdir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
399
442
|
<div class="tsd-comment tsd-typography"><p>The directory in which tests reside.</p>
|
|
400
|
-
</div
|
|
443
|
+
</div>
|
|
444
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
401
445
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.testdir</p></aside></section>
|
|
402
446
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a>
|
|
403
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig</span><a href="#tsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
447
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig</span><a href="#tsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
404
448
|
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TypescriptConfig</span></div><aside class="tsd-sources">
|
|
405
449
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfig</p></aside></section>
|
|
406
450
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDev" class="tsd-anchor"></a>
|
|
407
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev</span><a href="#tsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
451
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev</span><a href="#tsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
408
452
|
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Dev</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">TypescriptConfig</span></div>
|
|
409
453
|
<div class="tsd-comment tsd-typography"><p>A typescript configuration file which covers all files (sources, tests, projen).</p>
|
|
410
|
-
</div
|
|
454
|
+
</div>
|
|
455
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
411
456
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigDev</p></aside></section>
|
|
412
457
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigEslint" class="tsd-anchor"></a>
|
|
413
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Eslint</span><a href="#tsconfigEslint" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
458
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Eslint</span><a href="#tsconfigEslint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
414
459
|
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TypescriptConfig</span></div><aside class="tsd-sources">
|
|
415
460
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tsconfigEslint</p></aside></section>
|
|
416
461
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="upgradeWorkflow" class="tsd-anchor"></a>
|
|
417
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>upgrade<wbr/>Workflow</span><a href="#upgradeWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
462
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>upgrade<wbr/>Workflow</span><a href="#upgradeWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
418
463
|
<div class="tsd-signature"><span class="tsd-kind-property">upgrade<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">UpgradeDependencies</span></div>
|
|
419
464
|
<div class="tsd-comment tsd-typography"><p>The upgrade workflow.</p>
|
|
420
|
-
</div
|
|
465
|
+
</div>
|
|
466
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
421
467
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.upgradeWorkflow</p></aside></section>
|
|
422
468
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a>
|
|
423
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
469
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
424
470
|
<div class="tsd-signature"><span class="tsd-kind-property">vscode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">VsCode</span></div>
|
|
425
471
|
<div class="tsd-comment tsd-typography"><p>Access all VSCode components.</p>
|
|
426
472
|
<p>This will be <code>undefined</code> for subprojects.</p>
|
|
427
|
-
</div
|
|
473
|
+
</div>
|
|
474
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
428
475
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.vscode</p></aside></section>
|
|
429
476
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchTask" class="tsd-anchor"></a>
|
|
430
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Task</span><a href="#watchTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
477
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Task</span><a href="#watchTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
431
478
|
<div class="tsd-signature"><span class="tsd-kind-property">watch<wbr/>Task</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Task</span></div>
|
|
432
479
|
<div class="tsd-comment tsd-typography"><p>The "watch" task.</p>
|
|
433
|
-
</div
|
|
480
|
+
</div>
|
|
481
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
434
482
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.watchTask</p></aside></section>
|
|
435
483
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="workflowBootstrapSteps" class="tsd-anchor"></a>
|
|
436
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowBootstrapSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
484
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowBootstrapSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
437
485
|
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Bootstrap<wbr/>Steps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
438
486
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowBootstrapSteps</p></aside></section>
|
|
487
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="workflowPackageCache" class="tsd-anchor"></a>
|
|
488
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Package<wbr/>Cache</span><a href="#workflowPackageCache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
489
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Package<wbr/>Cache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
|
490
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.workflowPackageCache</p></aside></section>
|
|
439
491
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="DEFAULT_TASK" class="tsd-anchor"></a>
|
|
440
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>DEFAULT_<wbr/>TASK</span><a href="#DEFAULT_TASK" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
492
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>DEFAULT_<wbr/>TASK</span><a href="#DEFAULT_TASK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
441
493
|
<div class="tsd-signature"><span class="tsd-kind-property">DEFAULT_<wbr/>TASK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"default"</span><span class="tsd-signature-symbol"> = "default"</span></div>
|
|
442
494
|
<div class="tsd-comment tsd-typography"><p>The name of the default task (the task executed when <code>projen</code> is run without arguments). Normally
|
|
443
495
|
this task should synthesize the project files.</p>
|
|
444
|
-
</div
|
|
496
|
+
</div>
|
|
497
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
445
498
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.DEFAULT_TASK</p></aside></section></section>
|
|
446
499
|
<section class="tsd-panel-group tsd-member-group">
|
|
447
500
|
<h2>Accessors</h2>
|
|
448
501
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowLibraryDependencies" class="tsd-anchor"></a>
|
|
449
|
-
<h3 class="tsd-anchor-link"><span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowLibraryDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
502
|
+
<h3 class="tsd-anchor-link"><span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowLibraryDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
450
503
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
451
504
|
<li class="tsd-signature" id="allowLibraryDependencies.allowLibraryDependencies-1"><span class="tsd-signature-symbol">get</span> allowLibraryDependencies<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
452
505
|
<li class="tsd-description">
|
|
506
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
453
507
|
<div class="tsd-comment tsd-typography">
|
|
454
|
-
<
|
|
455
|
-
</div>
|
|
456
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
508
|
+
<h4>Deprecated</h4><p>use <code>package.allowLibraryDependencies</code></p>
|
|
509
|
+
</div><aside class="tsd-sources">
|
|
457
510
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.allowLibraryDependencies</p></aside></li></ul></section>
|
|
458
511
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildTask" class="tsd-anchor"></a>
|
|
459
|
-
<h3 class="tsd-anchor-link"><span>build<wbr/>Task</span><a href="#buildTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
512
|
+
<h3 class="tsd-anchor-link"><span>build<wbr/>Task</span><a href="#buildTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
460
513
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
461
514
|
<li class="tsd-signature" id="buildTask.buildTask-1"><span class="tsd-signature-symbol">get</span> buildTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
462
515
|
<li class="tsd-description">
|
|
463
516
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
464
517
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildTask</p></aside></li></ul></section>
|
|
465
518
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflowJobId" class="tsd-anchor"></a>
|
|
466
|
-
<h3 class="tsd-anchor-link"><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span><a href="#buildWorkflowJobId" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
519
|
+
<h3 class="tsd-anchor-link"><span>build<wbr/>Workflow<wbr/>Job<wbr/>Id</span><a href="#buildWorkflowJobId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
467
520
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
468
521
|
<li class="tsd-signature" id="buildWorkflowJobId.buildWorkflowJobId-1"><span class="tsd-signature-symbol">get</span> buildWorkflowJobId<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
|
|
469
522
|
<li class="tsd-description">
|
|
470
523
|
<div class="tsd-comment tsd-typography"><p>The job ID of the build workflow.</p>
|
|
471
524
|
</div>
|
|
472
|
-
<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
|
|
525
|
+
<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>
|
|
526
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
473
527
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.buildWorkflowJobId</p></aside></li></ul></section>
|
|
474
528
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersion" class="tsd-anchor"></a>
|
|
475
|
-
<h3 class="tsd-anchor-link"><span>cdk<wbr/>Version</span><a href="#cdkVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
529
|
+
<h3 class="tsd-anchor-link"><span>cdk<wbr/>Version</span><a href="#cdkVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
476
530
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
477
531
|
<li class="tsd-signature" id="cdkVersion.cdkVersion-1"><span class="tsd-signature-symbol">get</span> cdkVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
478
532
|
<li class="tsd-description">
|
|
479
533
|
<div class="tsd-comment tsd-typography"><p>The CDK version this app is using.</p>
|
|
480
534
|
</div>
|
|
481
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4
|
|
535
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
536
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
482
537
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.cdkVersion</p></aside></li></ul></section>
|
|
483
538
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="compileTask" class="tsd-anchor"></a>
|
|
484
|
-
<h3 class="tsd-anchor-link"><span>compile<wbr/>Task</span><a href="#compileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
539
|
+
<h3 class="tsd-anchor-link"><span>compile<wbr/>Task</span><a href="#compileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
485
540
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
486
541
|
<li class="tsd-signature" id="compileTask.compileTask-1"><span class="tsd-signature-symbol">get</span> compileTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
487
542
|
<li class="tsd-description">
|
|
488
543
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
489
544
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.compileTask</p></aside></li></ul></section>
|
|
490
545
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="components" class="tsd-anchor"></a>
|
|
491
|
-
<h3 class="tsd-anchor-link"><span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
546
|
+
<h3 class="tsd-anchor-link"><span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
492
547
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
493
548
|
<li class="tsd-signature" id="components.components-1"><span class="tsd-signature-symbol">get</span> components<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Component</span><span class="tsd-signature-symbol">[]</span></li>
|
|
494
549
|
<li class="tsd-description">
|
|
495
550
|
<div class="tsd-comment tsd-typography"><p>Returns all the components within this project.</p>
|
|
496
551
|
</div>
|
|
497
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Component</span><span class="tsd-signature-symbol">[]</span></h4
|
|
552
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Component</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
553
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
498
554
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.components</p></aside></li></ul></section>
|
|
499
555
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ejected" class="tsd-anchor"></a>
|
|
500
|
-
<h3 class="tsd-anchor-link"><span>ejected</span><a href="#ejected" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
556
|
+
<h3 class="tsd-anchor-link"><span>ejected</span><a href="#ejected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
501
557
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
502
558
|
<li class="tsd-signature" id="ejected.ejected-1"><span class="tsd-signature-symbol">get</span> ejected<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
503
559
|
<li class="tsd-description">
|
|
504
560
|
<div class="tsd-comment tsd-typography"><p>Whether or not the project is being ejected.</p>
|
|
505
561
|
</div>
|
|
506
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4
|
|
562
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
563
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
507
564
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.ejected</p></aside></li></ul></section>
|
|
508
565
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" class="tsd-anchor"></a>
|
|
509
|
-
<h3 class="tsd-anchor-link"><span>entrypoint</span><a href="#entrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
566
|
+
<h3 class="tsd-anchor-link"><span>entrypoint</span><a href="#entrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
510
567
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
511
568
|
<li class="tsd-signature" id="entrypoint.entrypoint-1"><span class="tsd-signature-symbol">get</span> entrypoint<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
512
569
|
<li class="tsd-description">
|
|
570
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
513
571
|
<div class="tsd-comment tsd-typography">
|
|
514
|
-
<
|
|
515
|
-
</div>
|
|
516
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
572
|
+
<h4>Deprecated</h4><p>use <code>package.entrypoint</code></p>
|
|
573
|
+
</div><aside class="tsd-sources">
|
|
517
574
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.entrypoint</p></aside></li></ul></section>
|
|
518
575
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="files" class="tsd-anchor"></a>
|
|
519
|
-
<h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
576
|
+
<h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
520
577
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
521
578
|
<li class="tsd-signature" id="files.files-1"><span class="tsd-signature-symbol">get</span> files<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">FileBase</span><span class="tsd-signature-symbol">[]</span></li>
|
|
522
579
|
<li class="tsd-description">
|
|
523
580
|
<div class="tsd-comment tsd-typography"><p>All files in this project.</p>
|
|
524
581
|
</div>
|
|
525
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FileBase</span><span class="tsd-signature-symbol">[]</span></h4
|
|
582
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FileBase</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
583
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
526
584
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.files</p></aside></li></ul></section>
|
|
527
585
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="manifest" class="tsd-anchor"></a>
|
|
528
|
-
<h3 class="tsd-anchor-link"><span>manifest</span><a href="#manifest" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
586
|
+
<h3 class="tsd-anchor-link"><span>manifest</span><a href="#manifest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
529
587
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
530
588
|
<li class="tsd-signature" id="manifest.manifest-1"><span class="tsd-signature-symbol">get</span> manifest<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
531
589
|
<li class="tsd-description">
|
|
590
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
532
591
|
<div class="tsd-comment tsd-typography">
|
|
533
|
-
<
|
|
534
|
-
</div>
|
|
535
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
|
|
592
|
+
<h4>Deprecated</h4><p>use <code>package.addField(x, y)</code></p>
|
|
593
|
+
</div><aside class="tsd-sources">
|
|
536
594
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.manifest</p></aside></li></ul></section>
|
|
537
595
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" class="tsd-anchor"></a>
|
|
538
|
-
<h3 class="tsd-anchor-link"><span>max<wbr/>Node<wbr/>Version</span><a href="#maxNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
596
|
+
<h3 class="tsd-anchor-link"><span>max<wbr/>Node<wbr/>Version</span><a href="#maxNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
539
597
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
540
598
|
<li class="tsd-signature" id="maxNodeVersion.maxNodeVersion-1"><span class="tsd-signature-symbol">get</span> maxNodeVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
|
|
541
599
|
<li class="tsd-description">
|
|
542
600
|
<div class="tsd-comment tsd-typography"><p>Maximum node version required by this package.</p>
|
|
543
601
|
</div>
|
|
544
|
-
<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
|
|
602
|
+
<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>
|
|
603
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
545
604
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.maxNodeVersion</p></aside></li></ul></section>
|
|
546
605
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" class="tsd-anchor"></a>
|
|
547
|
-
<h3 class="tsd-anchor-link"><span>min<wbr/>Node<wbr/>Version</span><a href="#minNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
606
|
+
<h3 class="tsd-anchor-link"><span>min<wbr/>Node<wbr/>Version</span><a href="#minNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
548
607
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
549
608
|
<li class="tsd-signature" id="minNodeVersion.minNodeVersion-1"><span class="tsd-signature-symbol">get</span> minNodeVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
|
|
550
609
|
<li class="tsd-description">
|
|
551
610
|
<div class="tsd-comment tsd-typography"><p>Minimum node.js version required by this package.</p>
|
|
552
611
|
</div>
|
|
553
|
-
<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
|
|
612
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
|
|
613
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
554
614
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.minNodeVersion</p></aside></li></ul></section>
|
|
555
615
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
556
|
-
<h3 class="tsd-anchor-link"><span>package<wbr/>Manager</span><a href="#packageManager" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
616
|
+
<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>
|
|
557
617
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
558
618
|
<li class="tsd-signature" id="packageManager.packageManager-1"><span class="tsd-signature-symbol">get</span> packageManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">NodePackageManager</span></li>
|
|
559
619
|
<li class="tsd-description">
|
|
560
620
|
<div class="tsd-comment tsd-typography"><p>The package manager to use.</p>
|
|
561
|
-
|
|
562
|
-
<h3>Deprecated</h3><p>use <code>package.packageManager</code></p>
|
|
563
621
|
</div>
|
|
564
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">NodePackageManager</span></h4
|
|
622
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">NodePackageManager</span></h4>
|
|
623
|
+
<div class="tsd-comment tsd-typography">
|
|
624
|
+
<h4>Deprecated</h4><p>use <code>package.packageManager</code></p>
|
|
625
|
+
</div><aside class="tsd-sources">
|
|
565
626
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageManager</p></aside></li></ul></section>
|
|
566
627
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageTask" class="tsd-anchor"></a>
|
|
567
|
-
<h3 class="tsd-anchor-link"><span>package<wbr/>Task</span><a href="#packageTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
628
|
+
<h3 class="tsd-anchor-link"><span>package<wbr/>Task</span><a href="#packageTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
568
629
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
569
630
|
<li class="tsd-signature" id="packageTask.packageTask-1"><span class="tsd-signature-symbol">get</span> packageTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
570
631
|
<li class="tsd-description">
|
|
571
632
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
572
633
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.packageTask</p></aside></li></ul></section>
|
|
573
634
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postCompileTask" class="tsd-anchor"></a>
|
|
574
|
-
<h3 class="tsd-anchor-link"><span>post<wbr/>Compile<wbr/>Task</span><a href="#postCompileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
635
|
+
<h3 class="tsd-anchor-link"><span>post<wbr/>Compile<wbr/>Task</span><a href="#postCompileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
575
636
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
576
637
|
<li class="tsd-signature" id="postCompileTask.postCompileTask-1"><span class="tsd-signature-symbol">get</span> postCompileTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
577
638
|
<li class="tsd-description">
|
|
578
639
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
579
640
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postCompileTask</p></aside></li></ul></section>
|
|
580
641
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="preCompileTask" class="tsd-anchor"></a>
|
|
581
|
-
<h3 class="tsd-anchor-link"><span>pre<wbr/>Compile<wbr/>Task</span><a href="#preCompileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
642
|
+
<h3 class="tsd-anchor-link"><span>pre<wbr/>Compile<wbr/>Task</span><a href="#preCompileTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
582
643
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
583
644
|
<li class="tsd-signature" id="preCompileTask.preCompileTask-1"><span class="tsd-signature-symbol">get</span> preCompileTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
584
645
|
<li class="tsd-description">
|
|
585
646
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
|
|
586
647
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preCompileTask</p></aside></li></ul></section>
|
|
648
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="subprojects" class="tsd-anchor"></a>
|
|
649
|
+
<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
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
651
|
+
<li class="tsd-signature" id="subprojects.subprojects-1"><span class="tsd-signature-symbol">get</span> subprojects<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Project</span><span class="tsd-signature-symbol">[]</span></li>
|
|
652
|
+
<li class="tsd-description">
|
|
653
|
+
<div class="tsd-comment tsd-typography"><p>Returns all the subprojects within this project.</p>
|
|
654
|
+
</div>
|
|
655
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Project</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
656
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
657
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.subprojects</p></aside></li></ul></section>
|
|
587
658
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testTask" class="tsd-anchor"></a>
|
|
588
|
-
<h3 class="tsd-anchor-link"><span>test<wbr/>Task</span><a href="#testTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
659
|
+
<h3 class="tsd-anchor-link"><span>test<wbr/>Task</span><a href="#testTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
589
660
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
590
661
|
<li class="tsd-signature" id="testTask.testTask-1"><span class="tsd-signature-symbol">get</span> testTask<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span></li>
|
|
591
662
|
<li class="tsd-description">
|
|
@@ -594,9 +665,9 @@ this task should synthesize the project files.</p>
|
|
|
594
665
|
<section class="tsd-panel-group tsd-member-group">
|
|
595
666
|
<h2>Methods</h2>
|
|
596
667
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addBins" class="tsd-anchor"></a>
|
|
597
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Bins</span><a href="#addBins" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
668
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Bins</span><a href="#addBins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
598
669
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
599
|
-
<li class="tsd-signature tsd-anchor-link" id="addBins.addBins-1"><span class="tsd-kind-call-signature">add<wbr/>Bins</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bins</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addBins.addBins-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
670
|
+
<li class="tsd-signature tsd-anchor-link" id="addBins.addBins-1"><span class="tsd-kind-call-signature">add<wbr/>Bins</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bins</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addBins.addBins-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
600
671
|
<li class="tsd-description">
|
|
601
672
|
<div class="tsd-parameters">
|
|
602
673
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -606,9 +677,9 @@ this task should synthesize the project files.</p>
|
|
|
606
677
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
607
678
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBins</p></aside></li></ul></section>
|
|
608
679
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addBundledDeps" class="tsd-anchor"></a>
|
|
609
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Bundled<wbr/>Deps</span><a href="#addBundledDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
680
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Bundled<wbr/>Deps</span><a href="#addBundledDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
610
681
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
611
|
-
<li class="tsd-signature tsd-anchor-link" id="addBundledDeps.addBundledDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Bundled<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addBundledDeps.addBundledDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
682
|
+
<li class="tsd-signature tsd-anchor-link" id="addBundledDeps.addBundledDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Bundled<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addBundledDeps.addBundledDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
612
683
|
<li class="tsd-description">
|
|
613
684
|
<div class="tsd-comment tsd-typography"><p>Defines bundled dependencies.</p>
|
|
614
685
|
<p>Bundled dependencies will be added as normal dependencies as well as to the
|
|
@@ -623,13 +694,15 @@ this task should synthesize the project files.</p>
|
|
|
623
694
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
624
695
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
625
696
|
<code>module@^7</code>.</p>
|
|
626
|
-
</div
|
|
627
|
-
<
|
|
697
|
+
</div>
|
|
698
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
699
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
700
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
628
701
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addBundledDeps</p></aside></li></ul></section>
|
|
629
702
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addCdkDependency" class="tsd-anchor"></a>
|
|
630
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Cdk<wbr/>Dependency</span><a href="#addCdkDependency" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
703
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Cdk<wbr/>Dependency</span><a href="#addCdkDependency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
631
704
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
632
|
-
<li class="tsd-signature tsd-anchor-link" id="addCdkDependency.addCdkDependency-1"><span class="tsd-kind-call-signature">add<wbr/>Cdk<wbr/>Dependency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addCdkDependency.addCdkDependency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
705
|
+
<li class="tsd-signature tsd-anchor-link" id="addCdkDependency.addCdkDependency-1"><span class="tsd-kind-call-signature">add<wbr/>Cdk<wbr/>Dependency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addCdkDependency.addCdkDependency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
633
706
|
<li class="tsd-description">
|
|
634
707
|
<div class="tsd-comment tsd-typography"><p>Adds an AWS CDK module dependencies</p>
|
|
635
708
|
</div>
|
|
@@ -639,29 +712,32 @@ in your <code>package.json</code> file. You can upgrade manually or using <code>
|
|
|
639
712
|
<li>
|
|
640
713
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">modules</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
641
714
|
<div class="tsd-comment tsd-typography"><p>The list of modules to depend on</p>
|
|
642
|
-
</div
|
|
643
|
-
<
|
|
715
|
+
</div>
|
|
716
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
717
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
718
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
644
719
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addCdkDependency</p></aside></li></ul></section>
|
|
645
720
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addCompileCommand" class="tsd-anchor"></a>
|
|
646
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Compile<wbr/>Command</span><a href="#addCompileCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
721
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Compile<wbr/>Command</span><a href="#addCompileCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
647
722
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
648
|
-
<li class="tsd-signature tsd-anchor-link" id="addCompileCommand.addCompileCommand-1"><span class="tsd-kind-call-signature">add<wbr/>Compile<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addCompileCommand.addCompileCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
723
|
+
<li class="tsd-signature tsd-anchor-link" id="addCompileCommand.addCompileCommand-1"><span class="tsd-kind-call-signature">add<wbr/>Compile<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addCompileCommand.addCompileCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
649
724
|
<li class="tsd-description">
|
|
650
725
|
<div class="tsd-comment tsd-typography"><p>DEPRECATED</p>
|
|
651
|
-
|
|
652
|
-
<h3>Deprecated</h3><p>use <code>project.compileTask.exec()</code></p>
|
|
653
726
|
</div>
|
|
654
727
|
<div class="tsd-parameters">
|
|
655
728
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
656
729
|
<ul class="tsd-parameter-list">
|
|
657
730
|
<li>
|
|
658
731
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
659
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
732
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
733
|
+
<div class="tsd-comment tsd-typography">
|
|
734
|
+
<h4>Deprecated</h4><p>use <code>project.compileTask.exec()</code></p>
|
|
735
|
+
</div><aside class="tsd-sources">
|
|
660
736
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addCompileCommand</p></aside></li></ul></section>
|
|
661
737
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addDeps" class="tsd-anchor"></a>
|
|
662
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Deps</span><a href="#addDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
738
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Deps</span><a href="#addDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
663
739
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
664
|
-
<li class="tsd-signature tsd-anchor-link" id="addDeps.addDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDeps.addDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
740
|
+
<li class="tsd-signature tsd-anchor-link" id="addDeps.addDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDeps.addDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
665
741
|
<li class="tsd-description">
|
|
666
742
|
<div class="tsd-comment tsd-typography"><p>Defines normal dependencies.</p>
|
|
667
743
|
</div>
|
|
@@ -674,13 +750,15 @@ in your <code>package.json</code> file. You can upgrade manually or using <code>
|
|
|
674
750
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
675
751
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
676
752
|
<code>module@^7</code>.</p>
|
|
677
|
-
</div
|
|
678
|
-
<
|
|
753
|
+
</div>
|
|
754
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
755
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
756
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
679
757
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDeps</p></aside></li></ul></section>
|
|
680
758
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addDevDeps" class="tsd-anchor"></a>
|
|
681
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Dev<wbr/>Deps</span><a href="#addDevDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
759
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Dev<wbr/>Deps</span><a href="#addDevDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
682
760
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
683
|
-
<li class="tsd-signature tsd-anchor-link" id="addDevDeps.addDevDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Dev<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDevDeps.addDevDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
761
|
+
<li class="tsd-signature tsd-anchor-link" id="addDevDeps.addDevDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Dev<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addDevDeps.addDevDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
684
762
|
<li class="tsd-description">
|
|
685
763
|
<div class="tsd-comment tsd-typography"><p>Defines development/test dependencies.</p>
|
|
686
764
|
</div>
|
|
@@ -693,13 +771,15 @@ in your <code>package.json</code> file. You can upgrade manually or using <code>
|
|
|
693
771
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
694
772
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
695
773
|
<code>module@^7</code>.</p>
|
|
696
|
-
</div
|
|
697
|
-
<
|
|
774
|
+
</div>
|
|
775
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
776
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
777
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
698
778
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addDevDeps</p></aside></li></ul></section>
|
|
699
779
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addExcludeFromCleanup" class="tsd-anchor"></a>
|
|
700
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span><a href="#addExcludeFromCleanup" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
780
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span><a href="#addExcludeFromCleanup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
701
781
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
702
|
-
<li class="tsd-signature tsd-anchor-link" id="addExcludeFromCleanup.addExcludeFromCleanup-1"><span class="tsd-kind-call-signature">add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">globs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addExcludeFromCleanup.addExcludeFromCleanup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
782
|
+
<li class="tsd-signature tsd-anchor-link" id="addExcludeFromCleanup.addExcludeFromCleanup-1"><span class="tsd-kind-call-signature">add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">globs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addExcludeFromCleanup.addExcludeFromCleanup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
703
783
|
<li class="tsd-description">
|
|
704
784
|
<div class="tsd-comment tsd-typography"><p>Exclude the matching files from pre-synth cleanup. Can be used when, for example, some
|
|
705
785
|
source files include the projen marker and we don't want them to be erased during synth.</p>
|
|
@@ -710,13 +790,15 @@ source files include the projen marker and we don't want them to be erased d
|
|
|
710
790
|
<li>
|
|
711
791
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">globs</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
712
792
|
<div class="tsd-comment tsd-typography"><p>The glob patterns to match</p>
|
|
713
|
-
</div
|
|
714
|
-
<
|
|
793
|
+
</div>
|
|
794
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
795
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
796
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
715
797
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addExcludeFromCleanup</p></aside></li></ul></section>
|
|
716
798
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addFields" class="tsd-anchor"></a>
|
|
717
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Fields</span><a href="#addFields" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
799
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Fields</span><a href="#addFields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
718
800
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
719
|
-
<li class="tsd-signature tsd-anchor-link" id="addFields.addFields-1"><span class="tsd-kind-call-signature">add<wbr/>Fields</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addFields.addFields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
801
|
+
<li class="tsd-signature tsd-anchor-link" id="addFields.addFields-1"><span class="tsd-kind-call-signature">add<wbr/>Fields</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addFields.addFields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
720
802
|
<li class="tsd-description">
|
|
721
803
|
<div class="tsd-comment tsd-typography"><p>Directly set fields in <code>package.json</code>.</p>
|
|
722
804
|
</div>
|
|
@@ -727,15 +809,17 @@ source files include the projen marker and we don't want them to be erased d
|
|
|
727
809
|
<h5><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
728
810
|
<div class="tsd-comment tsd-typography"><p>The fields to set</p>
|
|
729
811
|
</div>
|
|
812
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
730
813
|
<ul class="tsd-parameters">
|
|
731
814
|
<li class="tsd-parameter-index-signature">
|
|
732
815
|
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li></ul></div>
|
|
733
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
816
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
817
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
734
818
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addFields</p></aside></li></ul></section>
|
|
735
819
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addGitIgnore" class="tsd-anchor"></a>
|
|
736
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Git<wbr/>Ignore</span><a href="#addGitIgnore" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
820
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Git<wbr/>Ignore</span><a href="#addGitIgnore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
737
821
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
738
|
-
<li class="tsd-signature tsd-anchor-link" id="addGitIgnore.addGitIgnore-1"><span class="tsd-kind-call-signature">add<wbr/>Git<wbr/>Ignore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addGitIgnore.addGitIgnore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
822
|
+
<li class="tsd-signature tsd-anchor-link" id="addGitIgnore.addGitIgnore-1"><span class="tsd-kind-call-signature">add<wbr/>Git<wbr/>Ignore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addGitIgnore.addGitIgnore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
739
823
|
<li class="tsd-description">
|
|
740
824
|
<div class="tsd-comment tsd-typography"><p>Adds a .gitignore pattern.</p>
|
|
741
825
|
</div>
|
|
@@ -745,13 +829,15 @@ source files include the projen marker and we don't want them to be erased d
|
|
|
745
829
|
<li>
|
|
746
830
|
<h5><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span></h5>
|
|
747
831
|
<div class="tsd-comment tsd-typography"><p>The glob pattern to ignore.</p>
|
|
748
|
-
</div
|
|
749
|
-
<
|
|
832
|
+
</div>
|
|
833
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
834
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
835
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
750
836
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addGitIgnore</p></aside></li></ul></section>
|
|
751
837
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addKeywords" class="tsd-anchor"></a>
|
|
752
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Keywords</span><a href="#addKeywords" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
838
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Keywords</span><a href="#addKeywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
753
839
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
754
|
-
<li class="tsd-signature tsd-anchor-link" id="addKeywords.addKeywords-1"><span class="tsd-kind-call-signature">add<wbr/>Keywords</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">keywords</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addKeywords.addKeywords-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
840
|
+
<li class="tsd-signature tsd-anchor-link" id="addKeywords.addKeywords-1"><span class="tsd-kind-call-signature">add<wbr/>Keywords</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">keywords</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addKeywords.addKeywords-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
755
841
|
<li class="tsd-description">
|
|
756
842
|
<div class="tsd-comment tsd-typography"><p>Adds keywords to package.json (deduplicated)</p>
|
|
757
843
|
</div>
|
|
@@ -761,13 +847,15 @@ source files include the projen marker and we don't want them to be erased d
|
|
|
761
847
|
<li>
|
|
762
848
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">keywords</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
763
849
|
<div class="tsd-comment tsd-typography"><p>The keywords to add</p>
|
|
764
|
-
</div
|
|
765
|
-
<
|
|
850
|
+
</div>
|
|
851
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
852
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
853
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
766
854
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addKeywords</p></aside></li></ul></section>
|
|
767
855
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addPackageIgnore" class="tsd-anchor"></a>
|
|
768
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Package<wbr/>Ignore</span><a href="#addPackageIgnore" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
856
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Package<wbr/>Ignore</span><a href="#addPackageIgnore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
769
857
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
770
|
-
<li class="tsd-signature tsd-anchor-link" id="addPackageIgnore.addPackageIgnore-1"><span class="tsd-kind-call-signature">add<wbr/>Package<wbr/>Ignore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPackageIgnore.addPackageIgnore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
858
|
+
<li class="tsd-signature tsd-anchor-link" id="addPackageIgnore.addPackageIgnore-1"><span class="tsd-kind-call-signature">add<wbr/>Package<wbr/>Ignore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPackageIgnore.addPackageIgnore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
771
859
|
<li class="tsd-description">
|
|
772
860
|
<div class="tsd-parameters">
|
|
773
861
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -777,9 +865,9 @@ source files include the projen marker and we don't want them to be erased d
|
|
|
777
865
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
778
866
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPackageIgnore</p></aside></li></ul></section>
|
|
779
867
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addPeerDeps" class="tsd-anchor"></a>
|
|
780
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Peer<wbr/>Deps</span><a href="#addPeerDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
868
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Peer<wbr/>Deps</span><a href="#addPeerDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
781
869
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
782
|
-
<li class="tsd-signature tsd-anchor-link" id="addPeerDeps.addPeerDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Peer<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPeerDeps.addPeerDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
870
|
+
<li class="tsd-signature tsd-anchor-link" id="addPeerDeps.addPeerDeps-1"><span class="tsd-kind-call-signature">add<wbr/>Peer<wbr/>Deps</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPeerDeps.addPeerDeps-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
783
871
|
<li class="tsd-description">
|
|
784
872
|
<div class="tsd-comment tsd-typography"><p>Defines peer dependencies.</p>
|
|
785
873
|
<p>When adding peer dependencies, a devDependency will also be added on the
|
|
@@ -795,13 +883,15 @@ your code against the minimum version required from your consumers.</p>
|
|
|
795
883
|
be installed in the next <code>npx projen</code> run and the version will be recorded
|
|
796
884
|
in your <code>package.json</code> file. You can upgrade manually or using <code>yarn add/upgrade</code>. If you wish to specify a version range use this syntax:
|
|
797
885
|
<code>module@^7</code>.</p>
|
|
798
|
-
</div
|
|
799
|
-
<
|
|
886
|
+
</div>
|
|
887
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
888
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
889
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
800
890
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addPeerDeps</p></aside></li></ul></section>
|
|
801
891
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addScripts" class="tsd-anchor"></a>
|
|
802
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Scripts</span><a href="#addScripts" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
892
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Scripts</span><a href="#addScripts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
803
893
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
804
|
-
<li class="tsd-signature tsd-anchor-link" id="addScripts.addScripts-1"><span class="tsd-kind-call-signature">add<wbr/>Scripts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scripts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addScripts.addScripts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
894
|
+
<li class="tsd-signature tsd-anchor-link" id="addScripts.addScripts-1"><span class="tsd-kind-call-signature">add<wbr/>Scripts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scripts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addScripts.addScripts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
805
895
|
<li class="tsd-description">
|
|
806
896
|
<div class="tsd-comment tsd-typography"><p>Replaces the contents of multiple npm package.json scripts.</p>
|
|
807
897
|
</div>
|
|
@@ -812,15 +902,17 @@ in your <code>package.json</code> file. You can upgrade manually or using <code>
|
|
|
812
902
|
<h5><span class="tsd-kind-parameter">scripts</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
813
903
|
<div class="tsd-comment tsd-typography"><p>The scripts to set</p>
|
|
814
904
|
</div>
|
|
905
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
815
906
|
<ul class="tsd-parameters">
|
|
816
907
|
<li class="tsd-parameter-index-signature">
|
|
817
908
|
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
|
|
818
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
909
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
910
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
819
911
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addScripts</p></aside></li></ul></section>
|
|
820
912
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addTask" class="tsd-anchor"></a>
|
|
821
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Task</span><a href="#addTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
913
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Task</span><a href="#addTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
822
914
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
823
|
-
<li class="tsd-signature tsd-anchor-link" id="addTask.addTask-1"><span class="tsd-kind-call-signature">add<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span><a href="#addTask.addTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
915
|
+
<li class="tsd-signature tsd-anchor-link" id="addTask.addTask-1"><span class="tsd-kind-call-signature">add<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Task</span><a href="#addTask.addTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
824
916
|
<li class="tsd-description">
|
|
825
917
|
<div class="tsd-comment tsd-typography"><p>Adds a new task to this project. This will fail if the project already has
|
|
826
918
|
a task with this name.</p>
|
|
@@ -831,39 +923,39 @@ a task with this name.</p>
|
|
|
831
923
|
<li>
|
|
832
924
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
833
925
|
<div class="tsd-comment tsd-typography"><p>The task name to add</p>
|
|
834
|
-
</div
|
|
926
|
+
</div>
|
|
927
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
835
928
|
<li>
|
|
836
929
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">TaskOptions</span></h5>
|
|
837
930
|
<div class="tsd-comment tsd-typography"><p>Task properties</p>
|
|
838
|
-
</div
|
|
839
|
-
<
|
|
931
|
+
</div>
|
|
932
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
933
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Task</span></h4>
|
|
934
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
840
935
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTask</p></aside></li></ul></section>
|
|
841
936
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addTestCommand" class="tsd-anchor"></a>
|
|
842
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Test<wbr/>Command</span><a href="#addTestCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
937
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Test<wbr/>Command</span><a href="#addTestCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
843
938
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
844
|
-
<li class="tsd-signature tsd-anchor-link" id="addTestCommand.addTestCommand-1"><span class="tsd-kind-call-signature">add<wbr/>Test<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTestCommand.addTestCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
939
|
+
<li class="tsd-signature tsd-anchor-link" id="addTestCommand.addTestCommand-1"><span class="tsd-kind-call-signature">add<wbr/>Test<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTestCommand.addTestCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
845
940
|
<li class="tsd-description">
|
|
846
941
|
<div class="tsd-comment tsd-typography"><p>DEPRECATED</p>
|
|
847
|
-
|
|
848
|
-
<h3>Deprecated</h3><p>use <code>project.testTask.exec()</code></p>
|
|
849
942
|
</div>
|
|
850
943
|
<div class="tsd-parameters">
|
|
851
944
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
852
945
|
<ul class="tsd-parameter-list">
|
|
853
946
|
<li>
|
|
854
947
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
855
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
948
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
949
|
+
<div class="tsd-comment tsd-typography">
|
|
950
|
+
<h4>Deprecated</h4><p>use <code>project.testTask.exec()</code></p>
|
|
951
|
+
</div><aside class="tsd-sources">
|
|
856
952
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTestCommand</p></aside></li></ul></section>
|
|
857
953
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addTip" class="tsd-anchor"></a>
|
|
858
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Tip</span><a href="#addTip" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
954
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Tip</span><a href="#addTip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
859
955
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
860
|
-
<li class="tsd-signature tsd-anchor-link" id="addTip.addTip-1"><span class="tsd-kind-call-signature">add<wbr/>Tip</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTip.addTip-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
956
|
+
<li class="tsd-signature tsd-anchor-link" id="addTip.addTip-1"><span class="tsd-kind-call-signature">add<wbr/>Tip</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTip.addTip-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
861
957
|
<li class="tsd-description">
|
|
862
958
|
<div class="tsd-comment tsd-typography"><p>Prints a "tip" message during synthesis.</p>
|
|
863
|
-
|
|
864
|
-
<h3>Deprecated</h3><ul>
|
|
865
|
-
<li>use <code>project.logger.info(message)</code> to show messages during synthesis</li>
|
|
866
|
-
</ul>
|
|
867
959
|
</div>
|
|
868
960
|
<div class="tsd-parameters">
|
|
869
961
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -871,19 +963,23 @@ a task with this name.</p>
|
|
|
871
963
|
<li>
|
|
872
964
|
<h5><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></h5>
|
|
873
965
|
<div class="tsd-comment tsd-typography"><p>The message</p>
|
|
874
|
-
</div
|
|
875
|
-
<
|
|
966
|
+
</div>
|
|
967
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
968
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
969
|
+
<div class="tsd-comment tsd-typography">
|
|
970
|
+
<h4>Deprecated</h4><ul>
|
|
971
|
+
<li>use <code>project.logger.info(message)</code> to show messages during synthesis</li>
|
|
972
|
+
</ul>
|
|
973
|
+
</div><aside class="tsd-sources">
|
|
876
974
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.addTip</p></aside></li></ul></section>
|
|
877
975
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="annotateGenerated" class="tsd-anchor"></a>
|
|
878
|
-
<h3 class="tsd-anchor-link"><span>annotate<wbr/>Generated</span><a href="#annotateGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
976
|
+
<h3 class="tsd-anchor-link"><span>annotate<wbr/>Generated</span><a href="#annotateGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
879
977
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
880
|
-
<li class="tsd-signature tsd-anchor-link" id="annotateGenerated.annotateGenerated-1"><span class="tsd-kind-call-signature">annotate<wbr/>Generated</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">glob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#annotateGenerated.annotateGenerated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
978
|
+
<li class="tsd-signature tsd-anchor-link" id="annotateGenerated.annotateGenerated-1"><span class="tsd-kind-call-signature">annotate<wbr/>Generated</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">glob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#annotateGenerated.annotateGenerated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
881
979
|
<li class="tsd-description">
|
|
882
980
|
<div class="tsd-comment tsd-typography"><p>Marks the provided file(s) as being generated. This is achieved using the
|
|
883
981
|
github-linguist attributes. Generated files do not count against the
|
|
884
982
|
repository statistics and language breakdown.</p>
|
|
885
|
-
|
|
886
|
-
<h3>See</h3><p><a href="https://github.com/github/linguist/blob/master/docs/overrides.md">https://github.com/github/linguist/blob/master/docs/overrides.md</a></p>
|
|
887
983
|
</div>
|
|
888
984
|
<div class="tsd-parameters">
|
|
889
985
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -891,17 +987,19 @@ repository statistics and language breakdown.</p>
|
|
|
891
987
|
<li>
|
|
892
988
|
<h5><span class="tsd-kind-parameter">glob</span>: <span class="tsd-signature-type">string</span></h5>
|
|
893
989
|
<div class="tsd-comment tsd-typography"><p>the glob pattern to match (could be a file path).</p>
|
|
894
|
-
</div
|
|
895
|
-
<
|
|
990
|
+
</div>
|
|
991
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
992
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
993
|
+
<div class="tsd-comment tsd-typography">
|
|
994
|
+
<h4>See</h4><p><a href="https://github.com/github/linguist/blob/master/docs/overrides.md">https://github.com/github/linguist/blob/master/docs/overrides.md</a></p>
|
|
995
|
+
</div><aside class="tsd-sources">
|
|
896
996
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.annotateGenerated</p></aside></li></ul></section>
|
|
897
997
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="hasScript" class="tsd-anchor"></a>
|
|
898
|
-
<h3 class="tsd-anchor-link"><span>has<wbr/>Script</span><a href="#hasScript" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
998
|
+
<h3 class="tsd-anchor-link"><span>has<wbr/>Script</span><a href="#hasScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
899
999
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
900
|
-
<li class="tsd-signature tsd-anchor-link" id="hasScript.hasScript-1"><span class="tsd-kind-call-signature">has<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasScript.hasScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1000
|
+
<li class="tsd-signature tsd-anchor-link" id="hasScript.hasScript-1"><span class="tsd-kind-call-signature">has<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasScript.hasScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
901
1001
|
<li class="tsd-description">
|
|
902
1002
|
<div class="tsd-comment tsd-typography"><p>Indicates if a script by the name name is defined.</p>
|
|
903
|
-
|
|
904
|
-
<h3>Deprecated</h3><p>Use <code>project.tasks.tryFind(name)</code></p>
|
|
905
1003
|
</div>
|
|
906
1004
|
<div class="tsd-parameters">
|
|
907
1005
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -909,31 +1007,37 @@ repository statistics and language breakdown.</p>
|
|
|
909
1007
|
<li>
|
|
910
1008
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
911
1009
|
<div class="tsd-comment tsd-typography"><p>The name of the script</p>
|
|
912
|
-
</div
|
|
913
|
-
<
|
|
1010
|
+
</div>
|
|
1011
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1012
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
1013
|
+
<div class="tsd-comment tsd-typography">
|
|
1014
|
+
<h4>Deprecated</h4><p>Use <code>project.tasks.tryFind(name)</code></p>
|
|
1015
|
+
</div><aside class="tsd-sources">
|
|
914
1016
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.hasScript</p></aside></li></ul></section>
|
|
915
1017
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postSynthesize" class="tsd-anchor"></a>
|
|
916
|
-
<h3 class="tsd-anchor-link"><span>post<wbr/>Synthesize</span><a href="#postSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1018
|
+
<h3 class="tsd-anchor-link"><span>post<wbr/>Synthesize</span><a href="#postSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
917
1019
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
918
|
-
<li class="tsd-signature tsd-anchor-link" id="postSynthesize.postSynthesize-1"><span class="tsd-kind-call-signature">post<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#postSynthesize.postSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1020
|
+
<li class="tsd-signature tsd-anchor-link" id="postSynthesize.postSynthesize-1"><span class="tsd-kind-call-signature">post<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#postSynthesize.postSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
919
1021
|
<li class="tsd-description">
|
|
920
1022
|
<div class="tsd-comment tsd-typography"><p>Called after all components are synthesized. Order is <em>not</em> guaranteed.</p>
|
|
921
1023
|
</div>
|
|
922
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
1024
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1025
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
923
1026
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.postSynthesize</p></aside></li></ul></section>
|
|
924
1027
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="preSynthesize" class="tsd-anchor"></a>
|
|
925
|
-
<h3 class="tsd-anchor-link"><span>pre<wbr/>Synthesize</span><a href="#preSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1028
|
+
<h3 class="tsd-anchor-link"><span>pre<wbr/>Synthesize</span><a href="#preSynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
926
1029
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
927
|
-
<li class="tsd-signature tsd-anchor-link" id="preSynthesize.preSynthesize-1"><span class="tsd-kind-call-signature">pre<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#preSynthesize.preSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1030
|
+
<li class="tsd-signature tsd-anchor-link" id="preSynthesize.preSynthesize-1"><span class="tsd-kind-call-signature">pre<wbr/>Synthesize</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#preSynthesize.preSynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
928
1031
|
<li class="tsd-description">
|
|
929
1032
|
<div class="tsd-comment tsd-typography"><p>Called before all components are synthesized.</p>
|
|
930
1033
|
</div>
|
|
931
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
1034
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1035
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
932
1036
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.preSynthesize</p></aside></li></ul></section>
|
|
933
1037
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeScript" class="tsd-anchor"></a>
|
|
934
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Script</span><a href="#removeScript" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1038
|
+
<h3 class="tsd-anchor-link"><span>remove<wbr/>Script</span><a href="#removeScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
935
1039
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
936
|
-
<li class="tsd-signature tsd-anchor-link" id="removeScript.removeScript-1"><span class="tsd-kind-call-signature">remove<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeScript.removeScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1040
|
+
<li class="tsd-signature tsd-anchor-link" id="removeScript.removeScript-1"><span class="tsd-kind-call-signature">remove<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeScript.removeScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
937
1041
|
<li class="tsd-description">
|
|
938
1042
|
<div class="tsd-comment tsd-typography"><p>Removes the npm script (always successful).</p>
|
|
939
1043
|
</div>
|
|
@@ -943,13 +1047,15 @@ repository statistics and language breakdown.</p>
|
|
|
943
1047
|
<li>
|
|
944
1048
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
945
1049
|
<div class="tsd-comment tsd-typography"><p>The name of the script.</p>
|
|
946
|
-
</div
|
|
947
|
-
<
|
|
1050
|
+
</div>
|
|
1051
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1052
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1053
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
948
1054
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeScript</p></aside></li></ul></section>
|
|
949
1055
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeTask" class="tsd-anchor"></a>
|
|
950
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Task</span><a href="#removeTask" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1056
|
+
<h3 class="tsd-anchor-link"><span>remove<wbr/>Task</span><a href="#removeTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
951
1057
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
952
|
-
<li class="tsd-signature tsd-anchor-link" id="removeTask.removeTask-1"><span class="tsd-kind-call-signature">remove<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span><a href="#removeTask.removeTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1058
|
+
<li class="tsd-signature tsd-anchor-link" id="removeTask.removeTask-1"><span class="tsd-kind-call-signature">remove<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span><a href="#removeTask.removeTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
953
1059
|
<li class="tsd-description">
|
|
954
1060
|
<div class="tsd-comment tsd-typography"><p>Removes a task from a project.</p>
|
|
955
1061
|
</div>
|
|
@@ -959,14 +1065,16 @@ repository statistics and language breakdown.</p>
|
|
|
959
1065
|
<li>
|
|
960
1066
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
961
1067
|
<div class="tsd-comment tsd-typography"><p>The name of the task to remove.</p>
|
|
962
|
-
</div
|
|
1068
|
+
</div>
|
|
1069
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
963
1070
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span></h4><p>The <code>Task</code> that was removed, otherwise <code>undefined</code>.</p>
|
|
964
|
-
|
|
1071
|
+
|
|
1072
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
965
1073
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeTask</p></aside></li></ul></section>
|
|
966
1074
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renderWorkflowSetup" class="tsd-anchor"></a>
|
|
967
|
-
<h3 class="tsd-anchor-link"><span>render<wbr/>Workflow<wbr/>Setup</span><a href="#renderWorkflowSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1075
|
+
<h3 class="tsd-anchor-link"><span>render<wbr/>Workflow<wbr/>Setup</span><a href="#renderWorkflowSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
968
1076
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
969
|
-
<li class="tsd-signature tsd-anchor-link" id="renderWorkflowSetup.renderWorkflowSetup-1"><span class="tsd-kind-call-signature">render<wbr/>Workflow<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span><a href="#renderWorkflowSetup.renderWorkflowSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1077
|
+
<li class="tsd-signature tsd-anchor-link" id="renderWorkflowSetup.renderWorkflowSetup-1"><span class="tsd-kind-call-signature">render<wbr/>Workflow<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span><a href="#renderWorkflowSetup.renderWorkflowSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
970
1078
|
<li class="tsd-description">
|
|
971
1079
|
<div class="tsd-comment tsd-typography"><p>Returns the set of workflow steps which should be executed to bootstrap a
|
|
972
1080
|
workflow.</p>
|
|
@@ -977,14 +1085,16 @@ workflow.</p>
|
|
|
977
1085
|
<li>
|
|
978
1086
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">RenderWorkflowSetupOptions</span></h5>
|
|
979
1087
|
<div class="tsd-comment tsd-typography"><p>Options.</p>
|
|
980
|
-
</div
|
|
1088
|
+
</div>
|
|
1089
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
981
1090
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></h4><p>Job steps</p>
|
|
982
|
-
|
|
1091
|
+
|
|
1092
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
983
1093
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.renderWorkflowSetup</p></aside></li></ul></section>
|
|
984
1094
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runTaskCommand" class="tsd-anchor"></a>
|
|
985
|
-
<h3 class="tsd-anchor-link"><span>run<wbr/>Task<wbr/>Command</span><a href="#runTaskCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1095
|
+
<h3 class="tsd-anchor-link"><span>run<wbr/>Task<wbr/>Command</span><a href="#runTaskCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
986
1096
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
987
|
-
<li class="tsd-signature tsd-anchor-link" id="runTaskCommand.runTaskCommand-1"><span class="tsd-kind-call-signature">run<wbr/>Task<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#runTaskCommand.runTaskCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1097
|
+
<li class="tsd-signature tsd-anchor-link" id="runTaskCommand.runTaskCommand-1"><span class="tsd-kind-call-signature">run<wbr/>Task<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#runTaskCommand.runTaskCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
988
1098
|
<li class="tsd-description">
|
|
989
1099
|
<div class="tsd-comment tsd-typography"><p>Returns the shell command to execute in order to run a task. This will
|
|
990
1100
|
typically be <code>npx projen TASK</code>.</p>
|
|
@@ -995,13 +1105,15 @@ typically be <code>npx projen TASK</code>.</p>
|
|
|
995
1105
|
<li>
|
|
996
1106
|
<h5><span class="tsd-kind-parameter">task</span>: <span class="tsd-signature-type ">Task</span></h5>
|
|
997
1107
|
<div class="tsd-comment tsd-typography"><p>The task for which the command is required</p>
|
|
998
|
-
</div
|
|
999
|
-
<
|
|
1108
|
+
</div>
|
|
1109
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1110
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
1111
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1000
1112
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.runTaskCommand</p></aside></li></ul></section>
|
|
1001
1113
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setScript" class="tsd-anchor"></a>
|
|
1002
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Script</span><a href="#setScript" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1114
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Script</span><a href="#setScript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1003
1115
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1004
|
-
<li class="tsd-signature tsd-anchor-link" id="setScript.setScript-1"><span class="tsd-kind-call-signature">set<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setScript.setScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1116
|
+
<li class="tsd-signature tsd-anchor-link" id="setScript.setScript-1"><span class="tsd-kind-call-signature">set<wbr/>Script</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setScript.setScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1005
1117
|
<li class="tsd-description">
|
|
1006
1118
|
<div class="tsd-comment tsd-typography"><p>Replaces the contents of an npm package.json script.</p>
|
|
1007
1119
|
</div>
|
|
@@ -1011,17 +1123,20 @@ typically be <code>npx projen TASK</code>.</p>
|
|
|
1011
1123
|
<li>
|
|
1012
1124
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1013
1125
|
<div class="tsd-comment tsd-typography"><p>The script name</p>
|
|
1014
|
-
</div
|
|
1126
|
+
</div>
|
|
1127
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1015
1128
|
<li>
|
|
1016
1129
|
<h5><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1017
1130
|
<div class="tsd-comment tsd-typography"><p>The command to execute</p>
|
|
1018
|
-
</div
|
|
1019
|
-
<
|
|
1131
|
+
</div>
|
|
1132
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1133
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1134
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1020
1135
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.setScript</p></aside></li></ul></section>
|
|
1021
1136
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="synth" class="tsd-anchor"></a>
|
|
1022
|
-
<h3 class="tsd-anchor-link"><span>synth</span><a href="#synth" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1137
|
+
<h3 class="tsd-anchor-link"><span>synth</span><a href="#synth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1023
1138
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1024
|
-
<li class="tsd-signature tsd-anchor-link" id="synth.synth-1"><span class="tsd-kind-call-signature">synth</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#synth.synth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1139
|
+
<li class="tsd-signature tsd-anchor-link" id="synth.synth-1"><span class="tsd-kind-call-signature">synth</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#synth.synth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1025
1140
|
<li class="tsd-description">
|
|
1026
1141
|
<div class="tsd-comment tsd-typography"><p>Synthesize all project files into <code>outdir</code>.</p>
|
|
1027
1142
|
<ol>
|
|
@@ -1033,12 +1148,13 @@ typically be <code>npx projen TASK</code>.</p>
|
|
|
1033
1148
|
<li>Call "this.postSynthesize()"</li>
|
|
1034
1149
|
</ol>
|
|
1035
1150
|
</div>
|
|
1036
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
1151
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1152
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1037
1153
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.synth</p></aside></li></ul></section>
|
|
1038
1154
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindFile" class="tsd-anchor"></a>
|
|
1039
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>File</span><a href="#tryFindFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1155
|
+
<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>
|
|
1040
1156
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1041
|
-
<li class="tsd-signature tsd-anchor-link" id="tryFindFile.tryFindFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span><a href="#tryFindFile.tryFindFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1157
|
+
<li class="tsd-signature tsd-anchor-link" id="tryFindFile.tryFindFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span><a href="#tryFindFile.tryFindFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1042
1158
|
<li class="tsd-description">
|
|
1043
1159
|
<div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and all
|
|
1044
1160
|
its subprojects.</p>
|
|
@@ -1050,18 +1166,18 @@ its subprojects.</p>
|
|
|
1050
1166
|
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1051
1167
|
<div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be resolved
|
|
1052
1168
|
from the root of <em>this</em> project.</p>
|
|
1053
|
-
</div
|
|
1169
|
+
</div>
|
|
1170
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1054
1171
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><p>a <code>FileBase</code> or undefined if there is no file in that path</p>
|
|
1055
|
-
|
|
1172
|
+
|
|
1173
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1056
1174
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindFile</p></aside></li></ul></section>
|
|
1057
1175
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindJsonFile" class="tsd-anchor"></a>
|
|
1058
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>Json<wbr/>File</span><a href="#tryFindJsonFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1176
|
+
<h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>Json<wbr/>File</span><a href="#tryFindJsonFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1059
1177
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1060
|
-
<li class="tsd-signature tsd-anchor-link" id="tryFindJsonFile.tryFindJsonFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>Json<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">JsonFile</span><a href="#tryFindJsonFile.tryFindJsonFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1178
|
+
<li class="tsd-signature tsd-anchor-link" id="tryFindJsonFile.tryFindJsonFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>Json<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">JsonFile</span><a href="#tryFindJsonFile.tryFindJsonFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1061
1179
|
<li class="tsd-description">
|
|
1062
1180
|
<div class="tsd-comment tsd-typography"><p>Finds a json file by name.</p>
|
|
1063
|
-
|
|
1064
|
-
<h3>Deprecated</h3><p>use <code>tryFindObjectFile</code></p>
|
|
1065
1181
|
</div>
|
|
1066
1182
|
<div class="tsd-parameters">
|
|
1067
1183
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -1069,13 +1185,17 @@ from the root of <em>this</em> project.</p>
|
|
|
1069
1185
|
<li>
|
|
1070
1186
|
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1071
1187
|
<div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
1072
|
-
</div
|
|
1073
|
-
<
|
|
1188
|
+
</div>
|
|
1189
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1190
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">JsonFile</span></h4>
|
|
1191
|
+
<div class="tsd-comment tsd-typography">
|
|
1192
|
+
<h4>Deprecated</h4><p>use <code>tryFindObjectFile</code></p>
|
|
1193
|
+
</div><aside class="tsd-sources">
|
|
1074
1194
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindJsonFile</p></aside></li></ul></section>
|
|
1075
1195
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindObjectFile" class="tsd-anchor"></a>
|
|
1076
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>Object<wbr/>File</span><a href="#tryFindObjectFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1196
|
+
<h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>Object<wbr/>File</span><a href="#tryFindObjectFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1077
1197
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1078
|
-
<li class="tsd-signature tsd-anchor-link" id="tryFindObjectFile.tryFindObjectFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>Object<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ObjectFile</span><a href="#tryFindObjectFile.tryFindObjectFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1198
|
+
<li class="tsd-signature tsd-anchor-link" id="tryFindObjectFile.tryFindObjectFile-1"><span class="tsd-kind-call-signature">try<wbr/>Find<wbr/>Object<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ObjectFile</span><a href="#tryFindObjectFile.tryFindObjectFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1079
1199
|
<li class="tsd-description">
|
|
1080
1200
|
<div class="tsd-comment tsd-typography"><p>Finds an object file (like JsonFile, YamlFile, etc.) by name.</p>
|
|
1081
1201
|
</div>
|
|
@@ -1085,13 +1205,15 @@ from the root of <em>this</em> project.</p>
|
|
|
1085
1205
|
<li>
|
|
1086
1206
|
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1087
1207
|
<div class="tsd-comment tsd-typography"><p>The file path.</p>
|
|
1088
|
-
</div
|
|
1089
|
-
<
|
|
1208
|
+
</div>
|
|
1209
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1210
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ObjectFile</span></h4>
|
|
1211
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1090
1212
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindObjectFile</p></aside></li></ul></section>
|
|
1091
1213
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryRemoveFile" class="tsd-anchor"></a>
|
|
1092
|
-
<h3 class="tsd-anchor-link"><span>try<wbr/>Remove<wbr/>File</span><a href="#tryRemoveFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1214
|
+
<h3 class="tsd-anchor-link"><span>try<wbr/>Remove<wbr/>File</span><a href="#tryRemoveFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1093
1215
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1094
|
-
<li class="tsd-signature tsd-anchor-link" id="tryRemoveFile.tryRemoveFile-1"><span class="tsd-kind-call-signature">try<wbr/>Remove<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span><a href="#tryRemoveFile.tryRemoveFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1216
|
+
<li class="tsd-signature tsd-anchor-link" id="tryRemoveFile.tryRemoveFile-1"><span class="tsd-kind-call-signature">try<wbr/>Remove<wbr/>File</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span><a href="#tryRemoveFile.tryRemoveFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1095
1217
|
<li class="tsd-description">
|
|
1096
1218
|
<div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and removes
|
|
1097
1219
|
it.</p>
|
|
@@ -1103,16 +1225,18 @@ it.</p>
|
|
|
1103
1225
|
<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1104
1226
|
<div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be
|
|
1105
1227
|
resolved from the root of <em>this</em> project.</p>
|
|
1106
|
-
</div
|
|
1228
|
+
</div>
|
|
1229
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1107
1230
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><p>a <code>FileBase</code> if the file was found and removed, or undefined if
|
|
1108
1231
|
the file was not found.</p>
|
|
1109
|
-
|
|
1232
|
+
|
|
1233
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1110
1234
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></li></ul></section></section></div>
|
|
1111
1235
|
<div class="col-sidebar">
|
|
1112
1236
|
<div class="page-menu">
|
|
1113
1237
|
<div class="tsd-navigation settings">
|
|
1114
1238
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1115
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
1239
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
1116
1240
|
<div class="tsd-accordion-details">
|
|
1117
1241
|
<div class="tsd-filter-visibility">
|
|
1118
1242
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -1124,119 +1248,124 @@ the file was not found.</p>
|
|
|
1124
1248
|
<div class="tsd-theme-toggle">
|
|
1125
1249
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1126
1250
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1127
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
1251
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1128
1252
|
<div class="tsd-accordion-details">
|
|
1129
1253
|
<ul>
|
|
1130
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon"
|
|
1131
|
-
<li><a href="#appEntrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1132
|
-
<li><a href="#artifactsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1133
|
-
<li><a href="#artifactsJavascriptDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1134
|
-
<li><a href="#autoApprove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1135
|
-
<li><a href="#autoMerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1136
|
-
<li><a href="#buildWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1137
|
-
<li><a href="#bundler" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1138
|
-
<li><a href="#cdkConfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1139
|
-
<li><a href="#cdkDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1140
|
-
<li><a href="#cdkTasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1141
|
-
<li><a href="#commitGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1142
|
-
<li><a href="#defaultTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1143
|
-
<li><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1144
|
-
<li><a href="#devContainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1145
|
-
<li><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1146
|
-
<li><a href="#docsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1147
|
-
<li><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1148
|
-
<li><a href="#gitattributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1149
|
-
<li><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1150
|
-
<li><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1151
|
-
<li><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1152
|
-
<li><a href="#initProject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1153
|
-
<li><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1154
|
-
<li><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1155
|
-
<li><a href="#logger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1156
|
-
<li><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1157
|
-
<li><a href="#nodeVersion" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1158
|
-
<li><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1159
|
-
<li><a href="#
|
|
1160
|
-
<li><a href="#
|
|
1161
|
-
<li><a href="#
|
|
1162
|
-
<li><a href="#
|
|
1163
|
-
<li><a href="#
|
|
1164
|
-
<li><a href="#
|
|
1165
|
-
<li><a href="#
|
|
1166
|
-
<li><a href="#
|
|
1167
|
-
<li><a href="#
|
|
1168
|
-
<li><a href="#
|
|
1169
|
-
<li><a href="#
|
|
1170
|
-
<li><a href="#
|
|
1171
|
-
<li><a href="#
|
|
1172
|
-
<li><a href="#
|
|
1173
|
-
<li><a href="#
|
|
1174
|
-
<li><a href="#
|
|
1175
|
-
<li><a href="#
|
|
1176
|
-
<li><a href="#
|
|
1177
|
-
<li><a href="#
|
|
1178
|
-
<li><a href="#
|
|
1179
|
-
<li><a href="#
|
|
1180
|
-
<li><a href="#
|
|
1181
|
-
<li><a href="#
|
|
1182
|
-
<li><a href="#
|
|
1183
|
-
<li><a href="#
|
|
1184
|
-
<li><a href="#
|
|
1185
|
-
<li><a href="#
|
|
1186
|
-
<li><a href="#
|
|
1187
|
-
<li><a href="#
|
|
1188
|
-
<li><a href="#
|
|
1189
|
-
<li><a href="#
|
|
1190
|
-
<li><a href="#
|
|
1191
|
-
<li><a href="#
|
|
1192
|
-
<li><a href="#
|
|
1193
|
-
<li><a href="#
|
|
1194
|
-
<li><a href="#
|
|
1195
|
-
<li><a href="#
|
|
1196
|
-
<li><a href="#
|
|
1197
|
-
<li><a href="#
|
|
1198
|
-
<li><a href="#
|
|
1199
|
-
<li><a href="#
|
|
1200
|
-
<li><a href="#
|
|
1201
|
-
<li><a href="#
|
|
1202
|
-
<li><a href="#
|
|
1203
|
-
<li><a href="#
|
|
1204
|
-
<li><a href="#
|
|
1205
|
-
<li><a href="#
|
|
1206
|
-
<li><a href="#
|
|
1207
|
-
<li><a href="#
|
|
1208
|
-
<li><a href="#
|
|
1209
|
-
<li><a href="#
|
|
1210
|
-
<li><a href="#
|
|
1211
|
-
<li><a href="#
|
|
1212
|
-
<li><a href="#
|
|
1213
|
-
<li><a href="#
|
|
1214
|
-
<li><a href="#
|
|
1215
|
-
<li><a href="#
|
|
1216
|
-
<li><a href="#
|
|
1217
|
-
<li><a href="#
|
|
1218
|
-
<li><a href="#
|
|
1219
|
-
<li><a href="#
|
|
1220
|
-
<li><a href="#
|
|
1221
|
-
<li><a href="#
|
|
1222
|
-
<li><a href="#
|
|
1223
|
-
<li><a href="#
|
|
1224
|
-
<li><a href="#
|
|
1225
|
-
<li><a href="#
|
|
1226
|
-
<li><a href="#
|
|
1227
|
-
<li><a href="#
|
|
1254
|
+
<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>
|
|
1255
|
+
<li><a href="#appEntrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>app<wbr/>Entrypoint</span></a></li>
|
|
1256
|
+
<li><a href="#artifactsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a></li>
|
|
1257
|
+
<li><a href="#artifactsJavascriptDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>artifacts<wbr/>Javascript<wbr/>Directory</span></a></li>
|
|
1258
|
+
<li><a href="#autoApprove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Approve</span></a></li>
|
|
1259
|
+
<li><a href="#autoMerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a></li>
|
|
1260
|
+
<li><a href="#buildWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a></li>
|
|
1261
|
+
<li><a href="#bundler" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bundler</span></a></li>
|
|
1262
|
+
<li><a href="#cdkConfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Config</span></a></li>
|
|
1263
|
+
<li><a href="#cdkDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Deps</span></a></li>
|
|
1264
|
+
<li><a href="#cdkTasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdk<wbr/>Tasks</span></a></li>
|
|
1265
|
+
<li><a href="#commitGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a></li>
|
|
1266
|
+
<li><a href="#defaultTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Task</span></a></li>
|
|
1267
|
+
<li><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>deps</span></a></li>
|
|
1268
|
+
<li><a href="#devContainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dev<wbr/>Container</span></a></li>
|
|
1269
|
+
<li><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>docgen</span></a></li>
|
|
1270
|
+
<li><a href="#docsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a></li>
|
|
1271
|
+
<li><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>eslint</span></a></li>
|
|
1272
|
+
<li><a href="#gitattributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitattributes</span></a></li>
|
|
1273
|
+
<li><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>github</span></a></li>
|
|
1274
|
+
<li><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitignore</span></a></li>
|
|
1275
|
+
<li><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>gitpod</span></a></li>
|
|
1276
|
+
<li><a href="#initProject" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>init<wbr/>Project</span></a></li>
|
|
1277
|
+
<li><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>jest</span></a></li>
|
|
1278
|
+
<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>
|
|
1279
|
+
<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>
|
|
1280
|
+
<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>
|
|
1281
|
+
<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>
|
|
1282
|
+
<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>
|
|
1283
|
+
<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>
|
|
1284
|
+
<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>
|
|
1285
|
+
<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>
|
|
1286
|
+
<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>
|
|
1287
|
+
<li><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prettier</span></a></li>
|
|
1288
|
+
<li><a href="#projectBuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project<wbr/>Build</span></a></li>
|
|
1289
|
+
<li><a href="#projectType" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>project<wbr/>Type</span></a></li>
|
|
1290
|
+
<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>
|
|
1291
|
+
<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>
|
|
1292
|
+
<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>
|
|
1293
|
+
<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>
|
|
1294
|
+
<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>
|
|
1295
|
+
<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>
|
|
1296
|
+
<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>
|
|
1297
|
+
<li><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>testdir</span></a></li>
|
|
1298
|
+
<li><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig</span></a></li>
|
|
1299
|
+
<li><a href="#tsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a></li>
|
|
1300
|
+
<li><a href="#tsconfigEslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tsconfig<wbr/>Eslint</span></a></li>
|
|
1301
|
+
<li><a href="#upgradeWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>upgrade<wbr/>Workflow</span></a></li>
|
|
1302
|
+
<li><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>vscode</span></a></li>
|
|
1303
|
+
<li><a href="#watchTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>watch<wbr/>Task</span></a></li>
|
|
1304
|
+
<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>
|
|
1305
|
+
<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>
|
|
1306
|
+
<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>
|
|
1307
|
+
<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>
|
|
1308
|
+
<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>
|
|
1309
|
+
<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>
|
|
1310
|
+
<li><a href="#cdkVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>cdk<wbr/>Version</span></a></li>
|
|
1311
|
+
<li><a href="#compileTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>compile<wbr/>Task</span></a></li>
|
|
1312
|
+
<li><a href="#components" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>components</span></a></li>
|
|
1313
|
+
<li><a href="#ejected" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ejected</span></a></li>
|
|
1314
|
+
<li><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>entrypoint</span></a></li>
|
|
1315
|
+
<li><a href="#files" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>files</span></a></li>
|
|
1316
|
+
<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>
|
|
1317
|
+
<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>
|
|
1318
|
+
<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>
|
|
1319
|
+
<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>
|
|
1320
|
+
<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>
|
|
1321
|
+
<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>
|
|
1322
|
+
<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>
|
|
1323
|
+
<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>
|
|
1324
|
+
<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>
|
|
1325
|
+
<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>
|
|
1326
|
+
<li><a href="#addBundledDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Bundled<wbr/>Deps</span></a></li>
|
|
1327
|
+
<li><a href="#addCdkDependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Cdk<wbr/>Dependency</span></a></li>
|
|
1328
|
+
<li><a href="#addCompileCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Compile<wbr/>Command</span></a></li>
|
|
1329
|
+
<li><a href="#addDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Deps</span></a></li>
|
|
1330
|
+
<li><a href="#addDevDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Dev<wbr/>Deps</span></a></li>
|
|
1331
|
+
<li><a href="#addExcludeFromCleanup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Exclude<wbr/>From<wbr/>Cleanup</span></a></li>
|
|
1332
|
+
<li><a href="#addFields" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Fields</span></a></li>
|
|
1333
|
+
<li><a href="#addGitIgnore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Git<wbr/>Ignore</span></a></li>
|
|
1334
|
+
<li><a href="#addKeywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Keywords</span></a></li>
|
|
1335
|
+
<li><a href="#addPackageIgnore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Package<wbr/>Ignore</span></a></li>
|
|
1336
|
+
<li><a href="#addPeerDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Peer<wbr/>Deps</span></a></li>
|
|
1337
|
+
<li><a href="#addScripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Scripts</span></a></li>
|
|
1338
|
+
<li><a href="#addTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task</span></a></li>
|
|
1339
|
+
<li><a href="#addTestCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Test<wbr/>Command</span></a></li>
|
|
1340
|
+
<li><a href="#addTip" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Tip</span></a></li>
|
|
1341
|
+
<li><a href="#annotateGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>annotate<wbr/>Generated</span></a></li>
|
|
1342
|
+
<li><a href="#hasScript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Script</span></a></li>
|
|
1343
|
+
<li><a href="#postSynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a></li>
|
|
1344
|
+
<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>
|
|
1345
|
+
<li><a href="#removeScript" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Script</span></a></li>
|
|
1346
|
+
<li><a href="#removeTask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task</span></a></li>
|
|
1347
|
+
<li><a href="#renderWorkflowSetup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>render<wbr/>Workflow<wbr/>Setup</span></a></li>
|
|
1348
|
+
<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>
|
|
1349
|
+
<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>
|
|
1350
|
+
<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>
|
|
1351
|
+
<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>
|
|
1352
|
+
<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>
|
|
1353
|
+
<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>
|
|
1354
|
+
<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></ul></div></details></div>
|
|
1228
1355
|
<div class="site-menu">
|
|
1229
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
1356
|
+
<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>
|
|
1230
1357
|
<ul class="tsd-small-nested-navigation">
|
|
1231
|
-
<li><a href="Datastore.html"><svg class="tsd-kind-icon"
|
|
1232
|
-
<li><a href="
|
|
1233
|
-
<li><a href="
|
|
1234
|
-
<li><a href="
|
|
1235
|
-
<li><a href="
|
|
1236
|
-
<li><a href="../interfaces/
|
|
1237
|
-
<li><a href="../interfaces/
|
|
1238
|
-
<li><a href="../interfaces/
|
|
1239
|
-
<li><a href="../
|
|
1358
|
+
<li><a href="Datastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Datastore</span></a></li>
|
|
1359
|
+
<li><a href="GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
1360
|
+
<li><a href="RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
1361
|
+
<li><a href="ServerlessProject.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
1362
|
+
<li><a href="Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
1363
|
+
<li><a href="../interfaces/DatastoreOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Datastore<wbr/>Options</span></a></li>
|
|
1364
|
+
<li><a href="../interfaces/GraphQlApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Options</span></a></li>
|
|
1365
|
+
<li><a href="../interfaces/RestApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Options</span></a></li>
|
|
1366
|
+
<li><a href="../interfaces/ServerlessProjectOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Serverless<wbr/>Project<wbr/>Options</span></a></li>
|
|
1367
|
+
<li><a href="../interfaces/WorkflowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Options</span></a></li>
|
|
1368
|
+
<li><a href="../variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>PACKAGE_<wbr/>NAME</span></a></li></ul></nav></div></div></div>
|
|
1240
1369
|
<div class="tsd-generator">
|
|
1241
1370
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1242
1371
|
<div class="overlay"></div></body></html>
|