cdk-serverless 2.1.0 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +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,324 +28,343 @@
|
|
|
28
28
|
<div class="tsd-accordion-details">
|
|
29
29
|
<section class="tsd-index-section">
|
|
30
30
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
31
|
-
<div class="tsd-index-list"><a href="ServerlessProjectOptions.html#allowLibraryDependencies" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
32
|
-
<a href="ServerlessProjectOptions.html#appEntrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
33
|
-
<a href="ServerlessProjectOptions.html#artifactsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
34
|
-
<a href="ServerlessProjectOptions.html#authorEmail" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
35
|
-
<a href="ServerlessProjectOptions.html#authorName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
36
|
-
<a href="ServerlessProjectOptions.html#authorOrganization" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
37
|
-
<a href="ServerlessProjectOptions.html#authorUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
38
|
-
<a href="ServerlessProjectOptions.html#autoApproveOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
39
|
-
<a href="ServerlessProjectOptions.html#autoApproveUpgrades" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
40
|
-
<a href="ServerlessProjectOptions.html#autoDetectBin" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
41
|
-
<a href="ServerlessProjectOptions.html#autoMerge" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
42
|
-
<a href="ServerlessProjectOptions.html#autoMergeOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
43
|
-
<a href="ServerlessProjectOptions.html#bin" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
44
|
-
<a href="ServerlessProjectOptions.html#bugsEmail" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
45
|
-
<a href="ServerlessProjectOptions.html#bugsUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
46
|
-
<a href="ServerlessProjectOptions.html#buildCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
47
|
-
<a href="ServerlessProjectOptions.html#buildWorkflow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
48
|
-
<a href="ServerlessProjectOptions.html#buildWorkflowTriggers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
49
|
-
<a href="ServerlessProjectOptions.html#bundledDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
50
|
-
<a href="ServerlessProjectOptions.html#bundlerOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
51
|
-
<a href="ServerlessProjectOptions.html#cdkAssert" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
52
|
-
<a href="ServerlessProjectOptions.html#cdkAssertions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
53
|
-
<a href="ServerlessProjectOptions.html#cdkDependencies" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
54
|
-
<a href="ServerlessProjectOptions.html#cdkDependenciesAsDeps" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
55
|
-
<a href="ServerlessProjectOptions.html#cdkTestDependencies" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
56
|
-
<a href="ServerlessProjectOptions.html#cdkVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
57
|
-
<a href="ServerlessProjectOptions.html#cdkVersionPinning" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
58
|
-
<a href="ServerlessProjectOptions.html#cdkout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
59
|
-
<a href="ServerlessProjectOptions.html#clobber" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
60
|
-
<a href="ServerlessProjectOptions.html#codeArtifactOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
61
|
-
<a href="ServerlessProjectOptions.html#codeCov" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
62
|
-
<a href="ServerlessProjectOptions.html#codeCovTokenSecret" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
63
|
-
<a href="ServerlessProjectOptions.html#commitGenerated" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
64
|
-
<a href="ServerlessProjectOptions.html#constructsVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
65
|
-
<a href="ServerlessProjectOptions.html#context" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
66
|
-
<a href="ServerlessProjectOptions.html#copyrightOwner" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
67
|
-
<a href="ServerlessProjectOptions.html#copyrightPeriod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
68
|
-
<a href="ServerlessProjectOptions.html#defaultReleaseBranch" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
69
|
-
<a href="ServerlessProjectOptions.html#dependabot" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
70
|
-
<a href="ServerlessProjectOptions.html#dependabotOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
71
|
-
<a href="ServerlessProjectOptions.html#deps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
72
|
-
<a href="ServerlessProjectOptions.html#depsUpgrade" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
73
|
-
<a href="ServerlessProjectOptions.html#depsUpgradeOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
74
|
-
<a href="ServerlessProjectOptions.html#description" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
75
|
-
<a href="ServerlessProjectOptions.html#devContainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
76
|
-
<a href="ServerlessProjectOptions.html#devDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
77
|
-
<a href="ServerlessProjectOptions.html#disableTsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
78
|
-
<a href="ServerlessProjectOptions.html#disableTsconfigDev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
79
|
-
<a href="ServerlessProjectOptions.html#docgen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
80
|
-
<a href="ServerlessProjectOptions.html#docsDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
81
|
-
<a href="ServerlessProjectOptions.html#edgeLambdaAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
82
|
-
<a href="ServerlessProjectOptions.html#entrypoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
83
|
-
<a href="ServerlessProjectOptions.html#entrypointTypes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
84
|
-
<a href="ServerlessProjectOptions.html#eslint" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
85
|
-
<a href="ServerlessProjectOptions.html#eslintOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
86
|
-
<a href="ServerlessProjectOptions.html#featureFlags" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
87
|
-
<a href="ServerlessProjectOptions.html#gitIgnoreOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
88
|
-
<a href="ServerlessProjectOptions.html#gitOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
89
|
-
<a href="ServerlessProjectOptions.html#github" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
90
|
-
<a href="ServerlessProjectOptions.html#githubOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
91
|
-
<a href="ServerlessProjectOptions.html#gitignore" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
92
|
-
<a href="ServerlessProjectOptions.html#gitpod" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
93
|
-
<a href="ServerlessProjectOptions.html#homepage" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
94
|
-
<a href="ServerlessProjectOptions.html#integrationTestAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
95
|
-
<a href="ServerlessProjectOptions.html#jest" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
96
|
-
<a href="ServerlessProjectOptions.html#jestOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
97
|
-
<a href="ServerlessProjectOptions.html#jsiiReleaseVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
98
|
-
<a href="ServerlessProjectOptions.html#keywords" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
99
|
-
<a href="ServerlessProjectOptions.html#lambdaAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
100
|
-
<a href="ServerlessProjectOptions.html#lambdaExtensionAutoDiscover" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
101
|
-
<a href="ServerlessProjectOptions.html#lambdaOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
102
|
-
<a href="ServerlessProjectOptions.html#libdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
103
|
-
<a href="ServerlessProjectOptions.html#license" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
104
|
-
<a href="ServerlessProjectOptions.html#licensed" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
105
|
-
<a href="ServerlessProjectOptions.html#logging" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
106
|
-
<a href="ServerlessProjectOptions.html#majorVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
107
|
-
<a href="ServerlessProjectOptions.html#maxNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
108
|
-
<a href="ServerlessProjectOptions.html#mergify" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
109
|
-
<a href="ServerlessProjectOptions.html#mergifyOptions" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
110
|
-
<a href="ServerlessProjectOptions.html#minMajorVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
111
|
-
<a href="ServerlessProjectOptions.html#minNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
112
|
-
<a href="ServerlessProjectOptions.html#mutableBuild" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
113
|
-
<a href="ServerlessProjectOptions.html#name" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
114
|
-
<a href="ServerlessProjectOptions.html#npmAccess" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
115
|
-
<a href="ServerlessProjectOptions.html#npmDistTag" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
116
|
-
<a href="ServerlessProjectOptions.html#npmIgnoreOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
117
|
-
<a href="ServerlessProjectOptions.html#npmRegistry" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
118
|
-
<a href="ServerlessProjectOptions.html#npmRegistryUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
119
|
-
<a href="ServerlessProjectOptions.html#npmTokenSecret" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
120
|
-
<a href="ServerlessProjectOptions.html#npmignore" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
121
|
-
<a href="ServerlessProjectOptions.html#npmignoreEnabled" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
122
|
-
<a href="ServerlessProjectOptions.html#outdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
123
|
-
<a href="ServerlessProjectOptions.html#package" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
124
|
-
<a href="ServerlessProjectOptions.html#packageManager" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
125
|
-
<a href="ServerlessProjectOptions.html#packageName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
126
|
-
<a href="ServerlessProjectOptions.html#parent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
127
|
-
<a href="ServerlessProjectOptions.html#peerDependencyOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
128
|
-
<a href="ServerlessProjectOptions.html#peerDeps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
129
|
-
<a href="ServerlessProjectOptions.html#pnpmVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
130
|
-
<a href="ServerlessProjectOptions.html#postBuildSteps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
131
|
-
<a href="ServerlessProjectOptions.html#prerelease" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
132
|
-
<a href="ServerlessProjectOptions.html#prettier" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
133
|
-
<a href="ServerlessProjectOptions.html#prettierOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
134
|
-
<a href="ServerlessProjectOptions.html#projectType" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
135
|
-
<a href="ServerlessProjectOptions.html#projenCommand" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
136
|
-
<a href="ServerlessProjectOptions.html#projenCredentials" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
137
|
-
<a href="ServerlessProjectOptions.html#projenDevDependency" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
138
|
-
<a href="ServerlessProjectOptions.html#projenTokenSecret" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
139
|
-
<a href="ServerlessProjectOptions.html#projenVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
140
|
-
<a href="ServerlessProjectOptions.html#projenrcJs" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
141
|
-
<a href="ServerlessProjectOptions.html#projenrcJsOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
142
|
-
<a href="ServerlessProjectOptions.html#projenrcJson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
143
|
-
<a href="ServerlessProjectOptions.html#projenrcJsonOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
144
|
-
<a href="ServerlessProjectOptions.html#projenrcTs" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
145
|
-
<a href="ServerlessProjectOptions.html#projenrcTsOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
146
|
-
<a href="ServerlessProjectOptions.html#publishDryRun" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
147
|
-
<a href="ServerlessProjectOptions.html#publishTasks" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
148
|
-
<a href="ServerlessProjectOptions.html#pullRequestTemplate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
149
|
-
<a href="ServerlessProjectOptions.html#pullRequestTemplateContents" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
150
|
-
<a href="ServerlessProjectOptions.html#readme" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
151
|
-
<a href="ServerlessProjectOptions.html#release" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
152
|
-
<a href="ServerlessProjectOptions.html#releaseBranches" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
153
|
-
<a href="ServerlessProjectOptions.html#releaseEveryCommit" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
154
|
-
<a href="ServerlessProjectOptions.html#releaseFailureIssue" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
155
|
-
<a href="ServerlessProjectOptions.html#releaseFailureIssueLabel" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
156
|
-
<a href="ServerlessProjectOptions.html#releaseSchedule" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
157
|
-
<a href="ServerlessProjectOptions.html#releaseTagPrefix" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
158
|
-
<a href="ServerlessProjectOptions.html#releaseToNpm" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
159
|
-
<a href="ServerlessProjectOptions.html#releaseTrigger" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
160
|
-
<a href="ServerlessProjectOptions.html#releaseWorkflow" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
161
|
-
<a href="ServerlessProjectOptions.html#releaseWorkflowName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
162
|
-
<a href="ServerlessProjectOptions.html#releaseWorkflowSetupSteps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
163
|
-
<a href="ServerlessProjectOptions.html#renovatebot" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
164
|
-
<a href="ServerlessProjectOptions.html#renovatebotOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
165
|
-
<a href="ServerlessProjectOptions.html#repository" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
166
|
-
<a href="ServerlessProjectOptions.html#repositoryDirectory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
167
|
-
<a href="ServerlessProjectOptions.html#requireApproval" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
168
|
-
<a href="ServerlessProjectOptions.html#sampleCode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
169
|
-
<a href="ServerlessProjectOptions.html#scopedPackagesOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
170
|
-
<a href="ServerlessProjectOptions.html#scripts" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
171
|
-
<a href="ServerlessProjectOptions.html#srcdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
172
|
-
<a href="ServerlessProjectOptions.html#stability" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
173
|
-
<a href="ServerlessProjectOptions.html#stale" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
174
|
-
<a href="ServerlessProjectOptions.html#staleOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
175
|
-
<a href="ServerlessProjectOptions.html#testdir" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
176
|
-
<a href="ServerlessProjectOptions.html#tsconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
177
|
-
<a href="ServerlessProjectOptions.html#tsconfigDev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
178
|
-
<a href="ServerlessProjectOptions.html#tsconfigDevFile" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
179
|
-
<a href="ServerlessProjectOptions.html#typescriptVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
180
|
-
<a href="ServerlessProjectOptions.html#versionrcOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
181
|
-
<a href="ServerlessProjectOptions.html#vscode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
182
|
-
<a href="ServerlessProjectOptions.html#watchExcludes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
183
|
-
<a href="ServerlessProjectOptions.html#watchIncludes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
184
|
-
<a href="ServerlessProjectOptions.html#workflowBootstrapSteps" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
185
|
-
<a href="ServerlessProjectOptions.html#workflowContainerImage" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
186
|
-
<a href="ServerlessProjectOptions.html#workflowGitIdentity" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
187
|
-
<a href="ServerlessProjectOptions.html#workflowNodeVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
188
|
-
<a href="ServerlessProjectOptions.html#
|
|
31
|
+
<div class="tsd-index-list"><a href="ServerlessProjectOptions.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-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>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
32
|
+
<a href="ServerlessProjectOptions.html#appEntrypoint" 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>app<wbr/>Entrypoint?</span></a>
|
|
33
|
+
<a href="ServerlessProjectOptions.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>
|
|
34
|
+
<a href="ServerlessProjectOptions.html#authorEmail" 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>author<wbr/>Email?</span></a>
|
|
35
|
+
<a href="ServerlessProjectOptions.html#authorName" 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>author<wbr/>Name?</span></a>
|
|
36
|
+
<a href="ServerlessProjectOptions.html#authorOrganization" 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>author<wbr/>Organization?</span></a>
|
|
37
|
+
<a href="ServerlessProjectOptions.html#authorUrl" 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>author<wbr/>Url?</span></a>
|
|
38
|
+
<a href="ServerlessProjectOptions.html#autoApproveOptions" 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<wbr/>Options?</span></a>
|
|
39
|
+
<a href="ServerlessProjectOptions.html#autoApproveUpgrades" 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<wbr/>Upgrades?</span></a>
|
|
40
|
+
<a href="ServerlessProjectOptions.html#autoDetectBin" 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/>Detect<wbr/>Bin?</span></a>
|
|
41
|
+
<a href="ServerlessProjectOptions.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>
|
|
42
|
+
<a href="ServerlessProjectOptions.html#autoMergeOptions" 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<wbr/>Options?</span></a>
|
|
43
|
+
<a href="ServerlessProjectOptions.html#bin" 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>bin?</span></a>
|
|
44
|
+
<a href="ServerlessProjectOptions.html#bugsEmail" 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>bugs<wbr/>Email?</span></a>
|
|
45
|
+
<a href="ServerlessProjectOptions.html#bugsUrl" 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>bugs<wbr/>Url?</span></a>
|
|
46
|
+
<a href="ServerlessProjectOptions.html#buildCommand" 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/>Command?</span></a>
|
|
47
|
+
<a href="ServerlessProjectOptions.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>
|
|
48
|
+
<a href="ServerlessProjectOptions.html#buildWorkflowTriggers" 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<wbr/>Triggers?</span></a>
|
|
49
|
+
<a href="ServerlessProjectOptions.html#bundledDeps" 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>bundled<wbr/>Deps?</span></a>
|
|
50
|
+
<a href="ServerlessProjectOptions.html#bundlerOptions" 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<wbr/>Options?</span></a>
|
|
51
|
+
<a href="ServerlessProjectOptions.html#cdkAssert" 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>cdk<wbr/>Assert?</span></a>
|
|
52
|
+
<a href="ServerlessProjectOptions.html#cdkAssertions" 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/>Assertions?</span></a>
|
|
53
|
+
<a href="ServerlessProjectOptions.html#cdkDependencies" 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>cdk<wbr/>Dependencies?</span></a>
|
|
54
|
+
<a href="ServerlessProjectOptions.html#cdkDependenciesAsDeps" 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>cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps?</span></a>
|
|
55
|
+
<a href="ServerlessProjectOptions.html#cdkTestDependencies" 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>cdk<wbr/>Test<wbr/>Dependencies?</span></a>
|
|
56
|
+
<a href="ServerlessProjectOptions.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-1024"></use></svg><span>cdk<wbr/>Version</span></a>
|
|
57
|
+
<a href="ServerlessProjectOptions.html#cdkVersionPinning" 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/>Version<wbr/>Pinning?</span></a>
|
|
58
|
+
<a href="ServerlessProjectOptions.html#cdkout" 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>cdkout?</span></a>
|
|
59
|
+
<a href="ServerlessProjectOptions.html#clobber" 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>clobber?</span></a>
|
|
60
|
+
<a href="ServerlessProjectOptions.html#codeArtifactOptions" 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>code<wbr/>Artifact<wbr/>Options?</span></a>
|
|
61
|
+
<a href="ServerlessProjectOptions.html#codeCov" 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>code<wbr/>Cov?</span></a>
|
|
62
|
+
<a href="ServerlessProjectOptions.html#codeCovTokenSecret" 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>code<wbr/>Cov<wbr/>Token<wbr/>Secret?</span></a>
|
|
63
|
+
<a href="ServerlessProjectOptions.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>
|
|
64
|
+
<a href="ServerlessProjectOptions.html#constructsVersion" 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>constructs<wbr/>Version?</span></a>
|
|
65
|
+
<a href="ServerlessProjectOptions.html#context" 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>context?</span></a>
|
|
66
|
+
<a href="ServerlessProjectOptions.html#copyrightOwner" 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>copyright<wbr/>Owner?</span></a>
|
|
67
|
+
<a href="ServerlessProjectOptions.html#copyrightPeriod" 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>copyright<wbr/>Period?</span></a>
|
|
68
|
+
<a href="ServerlessProjectOptions.html#defaultReleaseBranch" 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/>Release<wbr/>Branch</span></a>
|
|
69
|
+
<a href="ServerlessProjectOptions.html#dependabot" 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>dependabot?</span></a>
|
|
70
|
+
<a href="ServerlessProjectOptions.html#dependabotOptions" 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>dependabot<wbr/>Options?</span></a>
|
|
71
|
+
<a href="ServerlessProjectOptions.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>
|
|
72
|
+
<a href="ServerlessProjectOptions.html#depsUpgrade" 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<wbr/>Upgrade?</span></a>
|
|
73
|
+
<a href="ServerlessProjectOptions.html#depsUpgradeOptions" 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<wbr/>Upgrade<wbr/>Options?</span></a>
|
|
74
|
+
<a href="ServerlessProjectOptions.html#description" 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>description?</span></a>
|
|
75
|
+
<a href="ServerlessProjectOptions.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>
|
|
76
|
+
<a href="ServerlessProjectOptions.html#devDeps" 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/>Deps?</span></a>
|
|
77
|
+
<a href="ServerlessProjectOptions.html#disableTsconfig" 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>disable<wbr/>Tsconfig?</span></a>
|
|
78
|
+
<a href="ServerlessProjectOptions.html#disableTsconfigDev" 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>disable<wbr/>Tsconfig<wbr/>Dev?</span></a>
|
|
79
|
+
<a href="ServerlessProjectOptions.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>
|
|
80
|
+
<a href="ServerlessProjectOptions.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>
|
|
81
|
+
<a href="ServerlessProjectOptions.html#edgeLambdaAutoDiscover" 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>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover?</span></a>
|
|
82
|
+
<a href="ServerlessProjectOptions.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-1024"></use></svg><span>entrypoint?</span></a>
|
|
83
|
+
<a href="ServerlessProjectOptions.html#entrypointTypes" 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>entrypoint<wbr/>Types?</span></a>
|
|
84
|
+
<a href="ServerlessProjectOptions.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>
|
|
85
|
+
<a href="ServerlessProjectOptions.html#eslintOptions" 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<wbr/>Options?</span></a>
|
|
86
|
+
<a href="ServerlessProjectOptions.html#featureFlags" 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>feature<wbr/>Flags?</span></a>
|
|
87
|
+
<a href="ServerlessProjectOptions.html#gitIgnoreOptions" 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>git<wbr/>Ignore<wbr/>Options?</span></a>
|
|
88
|
+
<a href="ServerlessProjectOptions.html#gitOptions" 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>git<wbr/>Options?</span></a>
|
|
89
|
+
<a href="ServerlessProjectOptions.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>
|
|
90
|
+
<a href="ServerlessProjectOptions.html#githubOptions" 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<wbr/>Options?</span></a>
|
|
91
|
+
<a href="ServerlessProjectOptions.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>
|
|
92
|
+
<a href="ServerlessProjectOptions.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>
|
|
93
|
+
<a href="ServerlessProjectOptions.html#homepage" 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>homepage?</span></a>
|
|
94
|
+
<a href="ServerlessProjectOptions.html#integrationTestAutoDiscover" 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>integration<wbr/>Test<wbr/>Auto<wbr/>Discover?</span></a>
|
|
95
|
+
<a href="ServerlessProjectOptions.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>
|
|
96
|
+
<a href="ServerlessProjectOptions.html#jestOptions" 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<wbr/>Options?</span></a>
|
|
97
|
+
<a href="ServerlessProjectOptions.html#jsiiReleaseVersion" 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>jsii<wbr/>Release<wbr/>Version?</span></a>
|
|
98
|
+
<a href="ServerlessProjectOptions.html#keywords" 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>keywords?</span></a>
|
|
99
|
+
<a href="ServerlessProjectOptions.html#lambdaAutoDiscover" 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>lambda<wbr/>Auto<wbr/>Discover?</span></a>
|
|
100
|
+
<a href="ServerlessProjectOptions.html#lambdaExtensionAutoDiscover" 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>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover?</span></a>
|
|
101
|
+
<a href="ServerlessProjectOptions.html#lambdaOptions" 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>lambda<wbr/>Options?</span></a>
|
|
102
|
+
<a href="ServerlessProjectOptions.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>
|
|
103
|
+
<a href="ServerlessProjectOptions.html#license" 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>license?</span></a>
|
|
104
|
+
<a href="ServerlessProjectOptions.html#licensed" 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>licensed?</span></a>
|
|
105
|
+
<a href="ServerlessProjectOptions.html#logging" 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>logging?</span></a>
|
|
106
|
+
<a href="ServerlessProjectOptions.html#majorVersion" 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>major<wbr/>Version?</span></a>
|
|
107
|
+
<a href="ServerlessProjectOptions.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-1024"></use></svg><span>max<wbr/>Node<wbr/>Version?</span></a>
|
|
108
|
+
<a href="ServerlessProjectOptions.html#mergify" 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>mergify?</span></a>
|
|
109
|
+
<a href="ServerlessProjectOptions.html#mergifyOptions" 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>mergify<wbr/>Options?</span></a>
|
|
110
|
+
<a href="ServerlessProjectOptions.html#minMajorVersion" 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>min<wbr/>Major<wbr/>Version?</span></a>
|
|
111
|
+
<a href="ServerlessProjectOptions.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-1024"></use></svg><span>min<wbr/>Node<wbr/>Version?</span></a>
|
|
112
|
+
<a href="ServerlessProjectOptions.html#mutableBuild" 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>mutable<wbr/>Build?</span></a>
|
|
113
|
+
<a href="ServerlessProjectOptions.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>
|
|
114
|
+
<a href="ServerlessProjectOptions.html#npmAccess" 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>npm<wbr/>Access?</span></a>
|
|
115
|
+
<a href="ServerlessProjectOptions.html#npmDistTag" 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>npm<wbr/>Dist<wbr/>Tag?</span></a>
|
|
116
|
+
<a href="ServerlessProjectOptions.html#npmIgnoreOptions" 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>npm<wbr/>Ignore<wbr/>Options?</span></a>
|
|
117
|
+
<a href="ServerlessProjectOptions.html#npmRegistry" 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>npm<wbr/>Registry?</span></a>
|
|
118
|
+
<a href="ServerlessProjectOptions.html#npmRegistryUrl" 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>npm<wbr/>Registry<wbr/>Url?</span></a>
|
|
119
|
+
<a href="ServerlessProjectOptions.html#npmTokenSecret" 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>npm<wbr/>Token<wbr/>Secret?</span></a>
|
|
120
|
+
<a href="ServerlessProjectOptions.html#npmignore" 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>npmignore?</span></a>
|
|
121
|
+
<a href="ServerlessProjectOptions.html#npmignoreEnabled" 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<wbr/>Enabled?</span></a>
|
|
122
|
+
<a href="ServerlessProjectOptions.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>
|
|
123
|
+
<a href="ServerlessProjectOptions.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>
|
|
124
|
+
<a href="ServerlessProjectOptions.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-1024"></use></svg><span>package<wbr/>Manager?</span></a>
|
|
125
|
+
<a href="ServerlessProjectOptions.html#packageName" 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<wbr/>Name?</span></a>
|
|
126
|
+
<a href="ServerlessProjectOptions.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>
|
|
127
|
+
<a href="ServerlessProjectOptions.html#peerDependencyOptions" 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>peer<wbr/>Dependency<wbr/>Options?</span></a>
|
|
128
|
+
<a href="ServerlessProjectOptions.html#peerDeps" 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>peer<wbr/>Deps?</span></a>
|
|
129
|
+
<a href="ServerlessProjectOptions.html#pnpmVersion" 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>pnpm<wbr/>Version?</span></a>
|
|
130
|
+
<a href="ServerlessProjectOptions.html#postBuildSteps" 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>post<wbr/>Build<wbr/>Steps?</span></a>
|
|
131
|
+
<a href="ServerlessProjectOptions.html#prerelease" 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>prerelease?</span></a>
|
|
132
|
+
<a href="ServerlessProjectOptions.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>
|
|
133
|
+
<a href="ServerlessProjectOptions.html#prettierOptions" 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<wbr/>Options?</span></a>
|
|
134
|
+
<a href="ServerlessProjectOptions.html#projectType" 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>project<wbr/>Type?</span></a>
|
|
135
|
+
<a href="ServerlessProjectOptions.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>
|
|
136
|
+
<a href="ServerlessProjectOptions.html#projenCredentials" 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/>Credentials?</span></a>
|
|
137
|
+
<a href="ServerlessProjectOptions.html#projenDevDependency" 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/>Dev<wbr/>Dependency?</span></a>
|
|
138
|
+
<a href="ServerlessProjectOptions.html#projenTokenSecret" 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>projen<wbr/>Token<wbr/>Secret?</span></a>
|
|
139
|
+
<a href="ServerlessProjectOptions.html#projenVersion" 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/>Version?</span></a>
|
|
140
|
+
<a href="ServerlessProjectOptions.html#projenrcJs" 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>projenrc<wbr/>Js?</span></a>
|
|
141
|
+
<a href="ServerlessProjectOptions.html#projenrcJsOptions" 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>projenrc<wbr/>Js<wbr/>Options?</span></a>
|
|
142
|
+
<a href="ServerlessProjectOptions.html#projenrcJson" 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>projenrc<wbr/>Json?</span></a>
|
|
143
|
+
<a href="ServerlessProjectOptions.html#projenrcJsonOptions" 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>projenrc<wbr/>Json<wbr/>Options?</span></a>
|
|
144
|
+
<a href="ServerlessProjectOptions.html#projenrcTs" 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>projenrc<wbr/>Ts?</span></a>
|
|
145
|
+
<a href="ServerlessProjectOptions.html#projenrcTsOptions" 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>projenrc<wbr/>Ts<wbr/>Options?</span></a>
|
|
146
|
+
<a href="ServerlessProjectOptions.html#publishDryRun" 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>publish<wbr/>Dry<wbr/>Run?</span></a>
|
|
147
|
+
<a href="ServerlessProjectOptions.html#publishTasks" 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>publish<wbr/>Tasks?</span></a>
|
|
148
|
+
<a href="ServerlessProjectOptions.html#pullRequestTemplate" 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>pull<wbr/>Request<wbr/>Template?</span></a>
|
|
149
|
+
<a href="ServerlessProjectOptions.html#pullRequestTemplateContents" 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>pull<wbr/>Request<wbr/>Template<wbr/>Contents?</span></a>
|
|
150
|
+
<a href="ServerlessProjectOptions.html#readme" 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>readme?</span></a>
|
|
151
|
+
<a href="ServerlessProjectOptions.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>
|
|
152
|
+
<a href="ServerlessProjectOptions.html#releaseBranches" 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<wbr/>Branches?</span></a>
|
|
153
|
+
<a href="ServerlessProjectOptions.html#releaseEveryCommit" 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>release<wbr/>Every<wbr/>Commit?</span></a>
|
|
154
|
+
<a href="ServerlessProjectOptions.html#releaseFailureIssue" 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<wbr/>Failure<wbr/>Issue?</span></a>
|
|
155
|
+
<a href="ServerlessProjectOptions.html#releaseFailureIssueLabel" 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<wbr/>Failure<wbr/>Issue<wbr/>Label?</span></a>
|
|
156
|
+
<a href="ServerlessProjectOptions.html#releaseSchedule" 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>release<wbr/>Schedule?</span></a>
|
|
157
|
+
<a href="ServerlessProjectOptions.html#releaseTagPrefix" 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<wbr/>Tag<wbr/>Prefix?</span></a>
|
|
158
|
+
<a href="ServerlessProjectOptions.html#releaseToNpm" 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<wbr/>To<wbr/>Npm?</span></a>
|
|
159
|
+
<a href="ServerlessProjectOptions.html#releaseTrigger" 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<wbr/>Trigger?</span></a>
|
|
160
|
+
<a href="ServerlessProjectOptions.html#releaseWorkflow" 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>release<wbr/>Workflow?</span></a>
|
|
161
|
+
<a href="ServerlessProjectOptions.html#releaseWorkflowName" 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<wbr/>Workflow<wbr/>Name?</span></a>
|
|
162
|
+
<a href="ServerlessProjectOptions.html#releaseWorkflowSetupSteps" 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<wbr/>Workflow<wbr/>Setup<wbr/>Steps?</span></a>
|
|
163
|
+
<a href="ServerlessProjectOptions.html#renovatebot" 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>renovatebot?</span></a>
|
|
164
|
+
<a href="ServerlessProjectOptions.html#renovatebotOptions" 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>renovatebot<wbr/>Options?</span></a>
|
|
165
|
+
<a href="ServerlessProjectOptions.html#repository" 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>repository?</span></a>
|
|
166
|
+
<a href="ServerlessProjectOptions.html#repositoryDirectory" 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>repository<wbr/>Directory?</span></a>
|
|
167
|
+
<a href="ServerlessProjectOptions.html#requireApproval" 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>require<wbr/>Approval?</span></a>
|
|
168
|
+
<a href="ServerlessProjectOptions.html#sampleCode" 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>sample<wbr/>Code?</span></a>
|
|
169
|
+
<a href="ServerlessProjectOptions.html#scopedPackagesOptions" 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>scoped<wbr/>Packages<wbr/>Options?</span></a>
|
|
170
|
+
<a href="ServerlessProjectOptions.html#scripts" 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>scripts?</span></a>
|
|
171
|
+
<a href="ServerlessProjectOptions.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>
|
|
172
|
+
<a href="ServerlessProjectOptions.html#stability" 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>stability?</span></a>
|
|
173
|
+
<a href="ServerlessProjectOptions.html#stale" 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>stale?</span></a>
|
|
174
|
+
<a href="ServerlessProjectOptions.html#staleOptions" 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>stale<wbr/>Options?</span></a>
|
|
175
|
+
<a href="ServerlessProjectOptions.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>
|
|
176
|
+
<a href="ServerlessProjectOptions.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>
|
|
177
|
+
<a href="ServerlessProjectOptions.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>
|
|
178
|
+
<a href="ServerlessProjectOptions.html#tsconfigDevFile" 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<wbr/>File?</span></a>
|
|
179
|
+
<a href="ServerlessProjectOptions.html#typescriptVersion" 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>typescript<wbr/>Version?</span></a>
|
|
180
|
+
<a href="ServerlessProjectOptions.html#versionrcOptions" 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>versionrc<wbr/>Options?</span></a>
|
|
181
|
+
<a href="ServerlessProjectOptions.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>
|
|
182
|
+
<a href="ServerlessProjectOptions.html#watchExcludes" 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/>Excludes?</span></a>
|
|
183
|
+
<a href="ServerlessProjectOptions.html#watchIncludes" 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/>Includes?</span></a>
|
|
184
|
+
<a href="ServerlessProjectOptions.html#workflowBootstrapSteps" 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>workflow<wbr/>Bootstrap<wbr/>Steps?</span></a>
|
|
185
|
+
<a href="ServerlessProjectOptions.html#workflowContainerImage" 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>workflow<wbr/>Container<wbr/>Image?</span></a>
|
|
186
|
+
<a href="ServerlessProjectOptions.html#workflowGitIdentity" 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>workflow<wbr/>Git<wbr/>Identity?</span></a>
|
|
187
|
+
<a href="ServerlessProjectOptions.html#workflowNodeVersion" 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>workflow<wbr/>Node<wbr/>Version?</span></a>
|
|
188
|
+
<a href="ServerlessProjectOptions.html#workflowPackageCache" 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>workflow<wbr/>Package<wbr/>Cache?</span></a>
|
|
189
|
+
<a href="ServerlessProjectOptions.html#workflowRunsOn" 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>workflow<wbr/>Runs<wbr/>On?</span></a>
|
|
189
190
|
</div></section></div></details></section></section>
|
|
190
191
|
<section class="tsd-panel-group tsd-member-group">
|
|
191
192
|
<h2>Properties</h2>
|
|
192
193
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowLibraryDependencies" class="tsd-anchor"></a>
|
|
193
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowLibraryDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
194
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowLibraryDependencies" 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>
|
|
194
195
|
<div class="tsd-signature"><span class="tsd-kind-property">allow<wbr/>Library<wbr/>Dependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
195
196
|
<div class="tsd-comment tsd-typography"><p>Allow the project to include <code>peerDependencies</code> and <code>bundledDependencies</code>.
|
|
196
197
|
This is normally only allowed for libraries. For apps, there's no meaning
|
|
197
198
|
for specifying these.</p>
|
|
198
|
-
|
|
199
|
-
<
|
|
199
|
+
</div>
|
|
200
|
+
<div class="tsd-comment tsd-typography">
|
|
201
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
200
202
|
</code><button>Copy</button></pre>
|
|
201
203
|
</div><aside class="tsd-sources">
|
|
202
204
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.allowLibraryDependencies</p></aside></section>
|
|
203
205
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appEntrypoint" class="tsd-anchor"></a>
|
|
204
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>app<wbr/>Entrypoint</span><a href="#appEntrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
206
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
205
207
|
<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>
|
|
206
208
|
<div class="tsd-comment tsd-typography"><p>The CDK app's entrypoint (relative to the source directory, which is
|
|
207
209
|
"src" by default).</p>
|
|
208
|
-
|
|
209
|
-
<
|
|
210
|
+
</div>
|
|
211
|
+
<div class="tsd-comment tsd-typography">
|
|
212
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"main.ts"</span>
|
|
210
213
|
</code><button>Copy</button></pre>
|
|
211
214
|
</div><aside class="tsd-sources">
|
|
212
215
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.appEntrypoint</p></aside></section>
|
|
213
216
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsDirectory" class="tsd-anchor"></a>
|
|
214
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>artifacts<wbr/>Directory</span><a href="#artifactsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
217
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
215
218
|
<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>
|
|
216
219
|
<div class="tsd-comment tsd-typography"><p>A directory which will contain build artifacts.</p>
|
|
217
|
-
|
|
218
|
-
<
|
|
220
|
+
</div>
|
|
221
|
+
<div class="tsd-comment tsd-typography">
|
|
222
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"dist"</span>
|
|
219
223
|
</code><button>Copy</button></pre>
|
|
220
224
|
</div><aside class="tsd-sources">
|
|
221
225
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.artifactsDirectory</p></aside></section>
|
|
222
226
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorEmail" class="tsd-anchor"></a>
|
|
223
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Email</span><a href="#authorEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
227
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Email</span><a href="#authorEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
224
228
|
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Email</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
225
229
|
<div class="tsd-comment tsd-typography"><p>Author's e-mail</p>
|
|
226
|
-
</div
|
|
230
|
+
</div>
|
|
231
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
227
232
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorEmail</p></aside></section>
|
|
228
233
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorName" class="tsd-anchor"></a>
|
|
229
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Name</span><a href="#authorName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
234
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Name</span><a href="#authorName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
230
235
|
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
231
236
|
<div class="tsd-comment tsd-typography"><p>Author's name</p>
|
|
232
|
-
</div
|
|
237
|
+
</div>
|
|
238
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
233
239
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorName</p></aside></section>
|
|
234
240
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorOrganization" class="tsd-anchor"></a>
|
|
235
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Organization</span><a href="#authorOrganization" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
241
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Organization</span><a href="#authorOrganization" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
236
242
|
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Organization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
237
243
|
<div class="tsd-comment tsd-typography"><p>Is the author an organization</p>
|
|
238
|
-
</div
|
|
244
|
+
</div>
|
|
245
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
239
246
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorOrganization</p></aside></section>
|
|
240
247
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorUrl" class="tsd-anchor"></a>
|
|
241
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Url</span><a href="#authorUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
248
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>author<wbr/>Url</span><a href="#authorUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
242
249
|
<div class="tsd-signature"><span class="tsd-kind-property">author<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
243
250
|
<div class="tsd-comment tsd-typography"><p>Author's URL / Website</p>
|
|
244
|
-
</div
|
|
251
|
+
</div>
|
|
252
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
245
253
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorUrl</p></aside></section>
|
|
246
254
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveOptions" class="tsd-anchor"></a>
|
|
247
|
-
<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<wbr/>Options</span><a href="#autoApproveOptions" 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>auto<wbr/>Approve<wbr/>Options</span><a href="#autoApproveOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
248
256
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Approve<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoApproveOptions</span></div>
|
|
249
257
|
<div class="tsd-comment tsd-typography"><p>Enable and configure the 'auto approve' workflow.</p>
|
|
250
|
-
|
|
251
|
-
<
|
|
258
|
+
</div>
|
|
259
|
+
<div class="tsd-comment tsd-typography">
|
|
260
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">auto</span><span class="hl-1"> </span><span class="hl-4">approve</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">disabled</span>
|
|
252
261
|
</code><button>Copy</button></pre>
|
|
253
262
|
</div><aside class="tsd-sources">
|
|
254
263
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveOptions</p></aside></section>
|
|
255
264
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveUpgrades" class="tsd-anchor"></a>
|
|
256
|
-
<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<wbr/>Upgrades</span><a href="#autoApproveUpgrades" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
265
|
+
<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<wbr/>Upgrades</span><a href="#autoApproveUpgrades" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
257
266
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Approve<wbr/>Upgrades</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
258
267
|
<div class="tsd-comment tsd-typography"><p>Automatically approve deps upgrade PRs, allowing them to be
|
|
259
268
|
merged by mergify (if configued).</p>
|
|
260
269
|
<p>Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
|
|
261
|
-
|
|
262
|
-
<
|
|
270
|
+
</div>
|
|
271
|
+
<div class="tsd-comment tsd-typography">
|
|
272
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span>
|
|
263
273
|
</code><button>Copy</button></pre>
|
|
264
274
|
</div><aside class="tsd-sources">
|
|
265
275
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveUpgrades</p></aside></section>
|
|
266
276
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoDetectBin" class="tsd-anchor"></a>
|
|
267
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Detect<wbr/>Bin</span><a href="#autoDetectBin" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
277
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auto<wbr/>Detect<wbr/>Bin</span><a href="#autoDetectBin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
268
278
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Detect<wbr/>Bin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
269
279
|
<div class="tsd-comment tsd-typography"><p>Automatically add all executables under the <code>bin</code> directory to your
|
|
270
280
|
<code>package.json</code> file under the <code>bin</code> section.</p>
|
|
271
|
-
|
|
272
|
-
<
|
|
281
|
+
</div>
|
|
282
|
+
<div class="tsd-comment tsd-typography">
|
|
283
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
273
284
|
</code><button>Copy</button></pre>
|
|
274
285
|
</div><aside class="tsd-sources">
|
|
275
286
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoDetectBin</p></aside></section>
|
|
276
287
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMerge" class="tsd-anchor"></a>
|
|
277
|
-
<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
|
|
288
|
+
<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>
|
|
278
289
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Merge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
279
290
|
<div class="tsd-comment tsd-typography"><p>Enable automatic merging on GitHub. Has no effect if <code>github.mergify</code>
|
|
280
291
|
is set to false.</p>
|
|
281
|
-
|
|
282
|
-
<
|
|
292
|
+
</div>
|
|
293
|
+
<div class="tsd-comment tsd-typography">
|
|
294
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
283
295
|
</code><button>Copy</button></pre>
|
|
284
296
|
</div><aside class="tsd-sources">
|
|
285
297
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMerge</p></aside></section>
|
|
286
298
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMergeOptions" class="tsd-anchor"></a>
|
|
287
|
-
<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<wbr/>Options</span><a href="#autoMergeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
299
|
+
<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<wbr/>Options</span><a href="#autoMergeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
288
300
|
<div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Merge<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">AutoMergeOptions</span></div>
|
|
289
301
|
<div class="tsd-comment tsd-typography"><p>Configure options for automatic merging on GitHub. Has no effect if
|
|
290
302
|
<code>github.mergify</code> or <code>autoMerge</code> is set to false.</p>
|
|
291
|
-
|
|
292
|
-
<
|
|
303
|
+
</div>
|
|
304
|
+
<div class="tsd-comment tsd-typography">
|
|
305
|
+
<h4>Default</h4><ul>
|
|
293
306
|
<li>see defaults in <code>AutoMergeOptions</code></li>
|
|
294
307
|
</ul>
|
|
295
308
|
</div><aside class="tsd-sources">
|
|
296
309
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMergeOptions</p></aside></section>
|
|
297
310
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bin" class="tsd-anchor"></a>
|
|
298
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bin</span><a href="#bin" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
311
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bin</span><a href="#bin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
299
312
|
<div class="tsd-signature"><span class="tsd-kind-property">bin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
300
313
|
<div class="tsd-comment tsd-typography"><p>Binary programs vended with your module.</p>
|
|
301
314
|
<p>You can use this option to add/customize how binaries are represented in
|
|
302
315
|
your <code>package.json</code>, but unless <code>autoDetectBin</code> is <code>false</code>, every
|
|
303
316
|
executable file under <code>bin</code> will automatically be added to this section.</p>
|
|
304
|
-
</div
|
|
317
|
+
</div>
|
|
318
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
305
319
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bin</p></aside></section>
|
|
306
320
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bugsEmail" class="tsd-anchor"></a>
|
|
307
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bugs<wbr/>Email</span><a href="#bugsEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
321
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bugs<wbr/>Email</span><a href="#bugsEmail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
308
322
|
<div class="tsd-signature"><span class="tsd-kind-property">bugs<wbr/>Email</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
309
323
|
<div class="tsd-comment tsd-typography"><p>The email address to which issues should be reported.</p>
|
|
310
|
-
</div
|
|
324
|
+
</div>
|
|
325
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
311
326
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsEmail</p></aside></section>
|
|
312
327
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bugsUrl" class="tsd-anchor"></a>
|
|
313
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bugs<wbr/>Url</span><a href="#bugsUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
328
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bugs<wbr/>Url</span><a href="#bugsUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
314
329
|
<div class="tsd-signature"><span class="tsd-kind-property">bugs<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
315
330
|
<div class="tsd-comment tsd-typography"><p>The url to your project's issue tracker.</p>
|
|
316
|
-
</div
|
|
331
|
+
</div>
|
|
332
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
317
333
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsUrl</p></aside></section>
|
|
318
334
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildCommand" class="tsd-anchor"></a>
|
|
319
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Command</span><a href="#buildCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
335
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>build<wbr/>Command</span><a href="#buildCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
320
336
|
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Command</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
321
337
|
<div class="tsd-comment tsd-typography"><p>A command to execute before synthesis. This command will be called when
|
|
322
338
|
running <code>cdk synth</code> or when <code>cdk watch</code> identifies a change in your source
|
|
323
339
|
code before redeployment.</p>
|
|
324
|
-
|
|
325
|
-
<
|
|
340
|
+
</div>
|
|
341
|
+
<div class="tsd-comment tsd-typography">
|
|
342
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">build</span><span class="hl-1"> </span><span class="hl-4">command</span>
|
|
326
343
|
</code><button>Copy</button></pre>
|
|
327
344
|
</div><aside class="tsd-sources">
|
|
328
345
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildCommand</p></aside></section>
|
|
329
346
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflow" class="tsd-anchor"></a>
|
|
330
|
-
<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
|
|
347
|
+
<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>
|
|
331
348
|
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
332
349
|
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
|
|
333
|
-
|
|
334
|
-
<
|
|
350
|
+
</div>
|
|
351
|
+
<div class="tsd-comment tsd-typography">
|
|
352
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
|
|
335
353
|
</code><button>Copy</button></pre>
|
|
336
354
|
</div><aside class="tsd-sources">
|
|
337
355
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflow</p></aside></section>
|
|
338
356
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflowTriggers" class="tsd-anchor"></a>
|
|
339
|
-
<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<wbr/>Triggers</span><a href="#buildWorkflowTriggers" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
357
|
+
<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<wbr/>Triggers</span><a href="#buildWorkflowTriggers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
340
358
|
<div class="tsd-signature"><span class="tsd-kind-property">build<wbr/>Workflow<wbr/>Triggers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Triggers</span></div>
|
|
341
359
|
<div class="tsd-comment tsd-typography"><p>Build workflow triggers</p>
|
|
342
|
-
|
|
343
|
-
<
|
|
360
|
+
</div>
|
|
361
|
+
<div class="tsd-comment tsd-typography">
|
|
362
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"{ pullRequest: {}, workflowDispatch: {} }"</span>
|
|
344
363
|
</code><button>Copy</button></pre>
|
|
345
364
|
</div><aside class="tsd-sources">
|
|
346
365
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflowTriggers</p></aside></section>
|
|
347
366
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundledDeps" class="tsd-anchor"></a>
|
|
348
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundled<wbr/>Deps</span><a href="#bundledDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
367
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundled<wbr/>Deps</span><a href="#bundledDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
349
368
|
<div class="tsd-signature"><span class="tsd-kind-property">bundled<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
350
369
|
<div class="tsd-comment tsd-typography"><p>List of dependencies to bundle into this module. These modules will be
|
|
351
370
|
added both to the <code>dependencies</code> section and <code>bundledDependencies</code> section of
|
|
@@ -356,48 +375,53 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
356
375
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
357
376
|
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
358
377
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
359
|
-
</div
|
|
378
|
+
</div>
|
|
379
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
360
380
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundledDeps</p></aside></section>
|
|
361
381
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundlerOptions" class="tsd-anchor"></a>
|
|
362
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundler<wbr/>Options</span><a href="#bundlerOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
382
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>bundler<wbr/>Options</span><a href="#bundlerOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
363
383
|
<div class="tsd-signature"><span class="tsd-kind-property">bundler<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">BundlerOptions</span></div>
|
|
364
384
|
<div class="tsd-comment tsd-typography"><p>Options for <code>Bundler</code>.</p>
|
|
365
|
-
</div
|
|
385
|
+
</div>
|
|
386
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
366
387
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundlerOptions</p></aside></section>
|
|
367
388
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkAssert" class="tsd-anchor"></a>
|
|
368
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Assert</span><a href="#cdkAssert" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
389
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Assert</span><a href="#cdkAssert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
369
390
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Assert</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
370
391
|
<div class="tsd-comment tsd-typography"><p>Warning: NodeJS only.
|
|
371
392
|
Install the @aws-cdk/assert library?</p>
|
|
372
|
-
|
|
373
|
-
<
|
|
393
|
+
</div>
|
|
394
|
+
<div class="tsd-comment tsd-typography">
|
|
395
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">AWS</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> >= </span><span class="hl-7">1.0</span><span class="hl-1">.</span><span class="hl-7">0</span><span class="hl-1"> < </span><span class="hl-7">2.0</span><span class="hl-1">.</span><span class="hl-7">0</span>
|
|
374
396
|
</code><button>Copy</button></pre>
|
|
375
397
|
|
|
376
|
-
<
|
|
398
|
+
<h4>Deprecated</h4><p>The @aws-cdk/assert library is deprecated in favor of
|
|
377
399
|
@aws-cdk/assertions (in V1) and included in <code>aws-cdk-lib</code> for V2.</p>
|
|
378
400
|
</div><aside class="tsd-sources">
|
|
379
401
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssert</p></aside></section>
|
|
380
402
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkAssertions" class="tsd-anchor"></a>
|
|
381
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Assertions</span><a href="#cdkAssertions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
403
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Assertions</span><a href="#cdkAssertions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
382
404
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Assertions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
383
405
|
<div class="tsd-comment tsd-typography"><p>Install the assertions library?</p>
|
|
384
406
|
<p>Only needed for CDK 1.x. If using CDK 2.x then
|
|
385
407
|
assertions is already included in 'aws-cdk-lib'</p>
|
|
386
|
-
|
|
387
|
-
<
|
|
408
|
+
</div>
|
|
409
|
+
<div class="tsd-comment tsd-typography">
|
|
410
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">AWS</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> >= </span><span class="hl-7">1.111</span><span class="hl-1">.</span><span class="hl-7">0</span><span class="hl-1"> < </span><span class="hl-7">2.0</span><span class="hl-1">.</span><span class="hl-7">0</span>
|
|
388
411
|
</code><button>Copy</button></pre>
|
|
389
412
|
</div><aside class="tsd-sources">
|
|
390
413
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssertions</p></aside></section>
|
|
391
414
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependencies" class="tsd-anchor"></a>
|
|
392
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Dependencies</span><a href="#cdkDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
415
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Dependencies</span><a href="#cdkDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
393
416
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Dependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
394
417
|
<div class="tsd-comment tsd-typography"><p>Which AWS CDKv1 modules this project requires</p>
|
|
395
|
-
|
|
396
|
-
<
|
|
418
|
+
</div>
|
|
419
|
+
<div class="tsd-comment tsd-typography">
|
|
420
|
+
<h4>Deprecated</h4><p>For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)</p>
|
|
397
421
|
</div><aside class="tsd-sources">
|
|
398
422
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependencies</p></aside></section>
|
|
399
423
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependenciesAsDeps" class="tsd-anchor"></a>
|
|
400
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span><a href="#cdkDependenciesAsDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
424
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span><a href="#cdkDependenciesAsDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
401
425
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Dependencies<wbr/>As<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
402
426
|
<div class="tsd-comment tsd-typography"><p>If this is enabled (default), all modules declared in <code>cdkDependencies</code> will be also added as
|
|
403
427
|
normal <code>dependencies</code> (as well as <code>peerDependencies</code>).</p>
|
|
@@ -406,169 +430,185 @@ when using npm < 7 or yarn, where peer dependencies are not automatically ins
|
|
|
406
430
|
If this is disabled, <code>cdkDependencies</code> will be added to <code>devDependencies</code> to ensure
|
|
407
431
|
they are present during development.</p>
|
|
408
432
|
<p>Note: this setting only applies to construct library projects</p>
|
|
409
|
-
|
|
410
|
-
<
|
|
433
|
+
</div>
|
|
434
|
+
<div class="tsd-comment tsd-typography">
|
|
435
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
411
436
|
</code><button>Copy</button></pre>
|
|
412
437
|
|
|
413
|
-
<
|
|
438
|
+
<h4>Deprecated</h4><p>Not supported in CDK v2.</p>
|
|
414
439
|
</div><aside class="tsd-sources">
|
|
415
440
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependenciesAsDeps</p></aside></section>
|
|
416
441
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkTestDependencies" 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 class="deprecated">cdk<wbr/>Test<wbr/>Dependencies</span><a href="#cdkTestDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
442
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">cdk<wbr/>Test<wbr/>Dependencies</span><a href="#cdkTestDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
418
443
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Test<wbr/>Dependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
419
444
|
<div class="tsd-comment tsd-typography"><p>AWS CDK modules required for testing.</p>
|
|
420
|
-
|
|
421
|
-
<
|
|
445
|
+
</div>
|
|
446
|
+
<div class="tsd-comment tsd-typography">
|
|
447
|
+
<h4>Deprecated</h4><p>For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead</p>
|
|
422
448
|
</div><aside class="tsd-sources">
|
|
423
449
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkTestDependencies</p></aside></section>
|
|
424
450
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersion" class="tsd-anchor"></a>
|
|
425
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Version</span><a href="#cdkVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
451
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
426
452
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
427
453
|
<div class="tsd-comment tsd-typography"><p>Minimum version of the AWS CDK to depend on.</p>
|
|
428
|
-
|
|
429
|
-
<
|
|
454
|
+
</div>
|
|
455
|
+
<div class="tsd-comment tsd-typography">
|
|
456
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"2.1.0"</span>
|
|
430
457
|
</code><button>Copy</button></pre>
|
|
431
458
|
</div><aside class="tsd-sources">
|
|
432
459
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersion</p></aside></section>
|
|
433
460
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersionPinning" class="tsd-anchor"></a>
|
|
434
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Version<wbr/>Pinning</span><a href="#cdkVersionPinning" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
461
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdk<wbr/>Version<wbr/>Pinning</span><a href="#cdkVersionPinning" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
435
462
|
<div class="tsd-signature"><span class="tsd-kind-property">cdk<wbr/>Version<wbr/>Pinning</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
436
463
|
<div class="tsd-comment tsd-typography"><p>Use pinned version instead of caret version for CDK.</p>
|
|
437
464
|
<p>You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
|
|
438
465
|
If you use experimental features this will let you define the moment you include breaking changes.</p>
|
|
439
|
-
</div
|
|
466
|
+
</div>
|
|
467
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
440
468
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersionPinning</p></aside></section>
|
|
441
469
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkout" class="tsd-anchor"></a>
|
|
442
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdkout</span><a href="#cdkout" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
470
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>cdkout</span><a href="#cdkout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
443
471
|
<div class="tsd-signature"><span class="tsd-kind-property">cdkout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
444
472
|
<div class="tsd-comment tsd-typography"><p>cdk.out directory.</p>
|
|
445
|
-
|
|
446
|
-
<
|
|
473
|
+
</div>
|
|
474
|
+
<div class="tsd-comment tsd-typography">
|
|
475
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"cdk.out"</span>
|
|
447
476
|
</code><button>Copy</button></pre>
|
|
448
477
|
</div><aside class="tsd-sources">
|
|
449
478
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkout</p></aside></section>
|
|
450
479
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clobber" class="tsd-anchor"></a>
|
|
451
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>clobber</span><a href="#clobber" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
480
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>clobber</span><a href="#clobber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
452
481
|
<div class="tsd-signature"><span class="tsd-kind-property">clobber</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
453
482
|
<div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
|
|
454
|
-
|
|
455
|
-
<
|
|
483
|
+
</div>
|
|
484
|
+
<div class="tsd-comment tsd-typography">
|
|
485
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1">, </span><span class="hl-4">but</span><span class="hl-1"> </span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span>
|
|
456
486
|
</code><button>Copy</button></pre>
|
|
457
487
|
</div><aside class="tsd-sources">
|
|
458
488
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.clobber</p></aside></section>
|
|
459
489
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeArtifactOptions" class="tsd-anchor"></a>
|
|
460
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Artifact<wbr/>Options</span><a href="#codeArtifactOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
490
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Artifact<wbr/>Options</span><a href="#codeArtifactOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
461
491
|
<div class="tsd-signature"><span class="tsd-kind-property">code<wbr/>Artifact<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">CodeArtifactOptions</span></div>
|
|
462
492
|
<div class="tsd-comment tsd-typography"><p>Options for npm packages using AWS CodeArtifact.
|
|
463
493
|
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
|
|
464
|
-
|
|
465
|
-
<
|
|
494
|
+
</div>
|
|
495
|
+
<div class="tsd-comment tsd-typography">
|
|
496
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">undefined</span>
|
|
466
497
|
</code><button>Copy</button></pre>
|
|
467
498
|
</div><aside class="tsd-sources">
|
|
468
499
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeArtifactOptions</p></aside></section>
|
|
469
500
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCov" class="tsd-anchor"></a>
|
|
470
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Cov</span><a href="#codeCov" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
501
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Cov</span><a href="#codeCov" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
471
502
|
<div class="tsd-signature"><span class="tsd-kind-property">code<wbr/>Cov</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
472
503
|
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow step for sending code coverage metrics to <a href="https://codecov.io/">https://codecov.io/</a>
|
|
473
504
|
Uses codecov/codecov-action@v3
|
|
474
|
-
A secret is required for private repos. Configured with</p>
|
|
475
|
-
|
|
476
|
-
<
|
|
477
|
-
<
|
|
505
|
+
A secret is required for private repos. Configured with <code>@codeCovTokenSecret</code></p>
|
|
506
|
+
</div>
|
|
507
|
+
<div class="tsd-comment tsd-typography">
|
|
508
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
478
509
|
</code><button>Copy</button></pre>
|
|
479
510
|
</div><aside class="tsd-sources">
|
|
480
511
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCov</p></aside></section>
|
|
481
512
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCovTokenSecret" class="tsd-anchor"></a>
|
|
482
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><a href="#codeCovTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
513
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><a href="#codeCovTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
483
514
|
<div class="tsd-signature"><span class="tsd-kind-property">code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
484
515
|
<div class="tsd-comment tsd-typography"><p>Define the secret name for a specified <a href="https://codecov.io/">https://codecov.io/</a> token
|
|
485
516
|
A secret is required to send coverage for private repositories</p>
|
|
486
|
-
|
|
487
|
-
<
|
|
517
|
+
</div>
|
|
518
|
+
<div class="tsd-comment tsd-typography">
|
|
519
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-3">this</span><span class="hl-1"> </span><span class="hl-4">option</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">specified</span><span class="hl-1">, </span><span class="hl-4">only</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">repositories</span><span class="hl-1"> </span><span class="hl-4">are</span><span class="hl-1"> </span><span class="hl-4">supported</span>
|
|
488
520
|
</code><button>Copy</button></pre>
|
|
489
521
|
</div><aside class="tsd-sources">
|
|
490
522
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCovTokenSecret</p></aside></section>
|
|
491
523
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitGenerated" class="tsd-anchor"></a>
|
|
492
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>commit<wbr/>Generated</span><a href="#commitGenerated" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
524
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
493
525
|
<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>
|
|
494
526
|
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
495
|
-
|
|
496
|
-
<
|
|
527
|
+
</div>
|
|
528
|
+
<div class="tsd-comment tsd-typography">
|
|
529
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
497
530
|
</code><button>Copy</button></pre>
|
|
498
531
|
</div><aside class="tsd-sources">
|
|
499
532
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.commitGenerated</p></aside></section>
|
|
500
533
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="constructsVersion" class="tsd-anchor"></a>
|
|
501
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>constructs<wbr/>Version</span><a href="#constructsVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
534
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>constructs<wbr/>Version</span><a href="#constructsVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
502
535
|
<div class="tsd-signature"><span class="tsd-kind-property">constructs<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
503
536
|
<div class="tsd-comment tsd-typography"><p>Minimum version of the <code>constructs</code> library to depend on.</p>
|
|
504
|
-
|
|
505
|
-
<
|
|
537
|
+
</div>
|
|
538
|
+
<div class="tsd-comment tsd-typography">
|
|
539
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> 1.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-2">"3.2.27"</span><span class="hl-1">, </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> 2.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">is</span><br/><span class="hl-2">"10.0.5"</span><span class="hl-1">.</span>
|
|
506
540
|
</code><button>Copy</button></pre>
|
|
507
541
|
</div><aside class="tsd-sources">
|
|
508
542
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.constructsVersion</p></aside></section>
|
|
509
543
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="context" class="tsd-anchor"></a>
|
|
510
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
544
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>context</span><a href="#context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
511
545
|
<div class="tsd-signature"><span class="tsd-kind-property">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">key</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></div>
|
|
512
546
|
<div class="tsd-comment tsd-typography"><p>Additional context to include in <code>cdk.json</code>.</p>
|
|
513
|
-
|
|
514
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">- </span><span class="hl-3">no</span><span class="hl-0"> </span><span class="hl-3">additional</span><span class="hl-0"> </span><span class="hl-3">context</span>
|
|
515
|
-
</code><button>Copy</button></pre>
|
|
516
547
|
</div>
|
|
517
548
|
<div class="tsd-type-declaration">
|
|
518
549
|
<h4>Type declaration</h4>
|
|
519
550
|
<ul class="tsd-parameters">
|
|
520
551
|
<li class="tsd-parameter-index-signature">
|
|
521
|
-
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></div
|
|
552
|
+
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></div>
|
|
553
|
+
<div class="tsd-comment tsd-typography">
|
|
554
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">additional</span><span class="hl-1"> </span><span class="hl-4">context</span>
|
|
555
|
+
</code><button>Copy</button></pre>
|
|
556
|
+
</div><aside class="tsd-sources">
|
|
522
557
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.context</p></aside></section>
|
|
523
558
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyrightOwner" class="tsd-anchor"></a>
|
|
524
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>copyright<wbr/>Owner</span><a href="#copyrightOwner" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
559
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>copyright<wbr/>Owner</span><a href="#copyrightOwner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
525
560
|
<div class="tsd-signature"><span class="tsd-kind-property">copyright<wbr/>Owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
526
561
|
<div class="tsd-comment tsd-typography"><p>License copyright owner.</p>
|
|
527
|
-
|
|
528
|
-
<
|
|
562
|
+
</div>
|
|
563
|
+
<div class="tsd-comment tsd-typography">
|
|
564
|
+
<h4>Default</h4><ul>
|
|
529
565
|
<li>defaults to the value of authorName or "" if <code>authorName</code> is undefined.</li>
|
|
530
566
|
</ul>
|
|
531
567
|
</div><aside class="tsd-sources">
|
|
532
568
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightOwner</p></aside></section>
|
|
533
569
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyrightPeriod" class="tsd-anchor"></a>
|
|
534
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>copyright<wbr/>Period</span><a href="#copyrightPeriod" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
570
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>copyright<wbr/>Period</span><a href="#copyrightPeriod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
535
571
|
<div class="tsd-signature"><span class="tsd-kind-property">copyright<wbr/>Period</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
536
572
|
<div class="tsd-comment tsd-typography"><p>The copyright years to put in the LICENSE file.</p>
|
|
537
|
-
|
|
538
|
-
<
|
|
573
|
+
</div>
|
|
574
|
+
<div class="tsd-comment tsd-typography">
|
|
575
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">current</span><span class="hl-1"> </span><span class="hl-4">year</span>
|
|
539
576
|
</code><button>Copy</button></pre>
|
|
540
577
|
</div><aside class="tsd-sources">
|
|
541
578
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightPeriod</p></aside></section>
|
|
542
579
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultReleaseBranch" class="tsd-anchor"></a>
|
|
543
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>default<wbr/>Release<wbr/>Branch</span><a href="#defaultReleaseBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
580
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>default<wbr/>Release<wbr/>Branch</span><a href="#defaultReleaseBranch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
544
581
|
<div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Release<wbr/>Branch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
545
582
|
<div class="tsd-comment tsd-typography"><p>The name of the main release branch.</p>
|
|
546
|
-
|
|
547
|
-
<
|
|
583
|
+
</div>
|
|
584
|
+
<div class="tsd-comment tsd-typography">
|
|
585
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"main"</span>
|
|
548
586
|
</code><button>Copy</button></pre>
|
|
549
587
|
</div><aside class="tsd-sources">
|
|
550
588
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.defaultReleaseBranch</p></aside></section>
|
|
551
589
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabot" class="tsd-anchor"></a>
|
|
552
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dependabot</span><a href="#dependabot" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
590
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dependabot</span><a href="#dependabot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
553
591
|
<div class="tsd-signature"><span class="tsd-kind-property">dependabot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
554
592
|
<div class="tsd-comment tsd-typography"><p>Use dependabot to handle dependency upgrades.
|
|
555
593
|
Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
556
|
-
|
|
557
|
-
<
|
|
594
|
+
</div>
|
|
595
|
+
<div class="tsd-comment tsd-typography">
|
|
596
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
558
597
|
</code><button>Copy</button></pre>
|
|
559
598
|
</div><aside class="tsd-sources">
|
|
560
599
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabot</p></aside></section>
|
|
561
600
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabotOptions" class="tsd-anchor"></a>
|
|
562
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dependabot<wbr/>Options</span><a href="#dependabotOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
601
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dependabot<wbr/>Options</span><a href="#dependabotOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
563
602
|
<div class="tsd-signature"><span class="tsd-kind-property">dependabot<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">DependabotOptions</span></div>
|
|
564
603
|
<div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
|
|
565
|
-
|
|
566
|
-
<
|
|
604
|
+
</div>
|
|
605
|
+
<div class="tsd-comment tsd-typography">
|
|
606
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
567
607
|
</code><button>Copy</button></pre>
|
|
568
608
|
</div><aside class="tsd-sources">
|
|
569
609
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabotOptions</p></aside></section>
|
|
570
610
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a>
|
|
571
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps</span><a href="#deps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
611
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
572
612
|
<div class="tsd-signature"><span class="tsd-kind-property">deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
573
613
|
<div class="tsd-comment tsd-typography"><p>Runtime dependencies of this module.</p>
|
|
574
614
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
@@ -577,54 +617,59 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
577
617
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
578
618
|
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
579
619
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
580
|
-
|
|
581
|
-
<
|
|
620
|
+
</div>
|
|
621
|
+
<div class="tsd-comment tsd-typography">
|
|
622
|
+
<h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[ </span><span class="hl-2">'express'</span><span class="hl-1">, </span><span class="hl-2">'lodash'</span><span class="hl-1">, </span><span class="hl-2">'foo@^2'</span><span class="hl-1"> ]</span>
|
|
582
623
|
</code><button>Copy</button></pre>
|
|
583
624
|
|
|
584
|
-
<
|
|
625
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
585
626
|
</code><button>Copy</button></pre>
|
|
586
627
|
|
|
587
|
-
<
|
|
628
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
588
629
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.deps</p></aside></section>
|
|
589
630
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgrade" class="tsd-anchor"></a>
|
|
590
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps<wbr/>Upgrade</span><a href="#depsUpgrade" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
631
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps<wbr/>Upgrade</span><a href="#depsUpgrade" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
591
632
|
<div class="tsd-signature"><span class="tsd-kind-property">deps<wbr/>Upgrade</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
592
633
|
<div class="tsd-comment tsd-typography"><p>Use github workflows to handle dependency upgrades.
|
|
593
634
|
Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
594
|
-
|
|
595
|
-
<
|
|
635
|
+
</div>
|
|
636
|
+
<div class="tsd-comment tsd-typography">
|
|
637
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
596
638
|
</code><button>Copy</button></pre>
|
|
597
639
|
</div><aside class="tsd-sources">
|
|
598
640
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgrade</p></aside></section>
|
|
599
641
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgradeOptions" class="tsd-anchor"></a>
|
|
600
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps<wbr/>Upgrade<wbr/>Options</span><a href="#depsUpgradeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
642
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>deps<wbr/>Upgrade<wbr/>Options</span><a href="#depsUpgradeOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
601
643
|
<div class="tsd-signature"><span class="tsd-kind-property">deps<wbr/>Upgrade<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">UpgradeDependenciesOptions</span></div>
|
|
602
644
|
<div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
|
|
603
|
-
|
|
604
|
-
<
|
|
645
|
+
</div>
|
|
646
|
+
<div class="tsd-comment tsd-typography">
|
|
647
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
605
648
|
</code><button>Copy</button></pre>
|
|
606
649
|
</div><aside class="tsd-sources">
|
|
607
650
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgradeOptions</p></aside></section>
|
|
608
651
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="description" class="tsd-anchor"></a>
|
|
609
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
652
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
610
653
|
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
611
654
|
<div class="tsd-comment tsd-typography"><p>The description is just a string that helps people understand the purpose of the package.
|
|
612
655
|
It can be used when searching for packages in a package manager as well.
|
|
613
656
|
See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-description">https://classic.yarnpkg.com/en/docs/package-json/#toc-description</a></p>
|
|
614
|
-
|
|
615
|
-
<
|
|
657
|
+
</div>
|
|
658
|
+
<div class="tsd-comment tsd-typography">
|
|
659
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
616
660
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.description</p></aside></section>
|
|
617
661
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devContainer" class="tsd-anchor"></a>
|
|
618
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Container</span><a href="#devContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
662
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
619
663
|
<div class="tsd-signature"><span class="tsd-kind-property">dev<wbr/>Container</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
620
664
|
<div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces)</p>
|
|
621
|
-
|
|
622
|
-
<
|
|
665
|
+
</div>
|
|
666
|
+
<div class="tsd-comment tsd-typography">
|
|
667
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
623
668
|
</code><button>Copy</button></pre>
|
|
624
669
|
</div><aside class="tsd-sources">
|
|
625
670
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devContainer</p></aside></section>
|
|
626
671
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devDeps" class="tsd-anchor"></a>
|
|
627
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Deps</span><a href="#devDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
672
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dev<wbr/>Deps</span><a href="#devDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
628
673
|
<div class="tsd-signature"><span class="tsd-kind-property">dev<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
629
674
|
<div class="tsd-comment tsd-typography"><p>Build dependencies for this module. These dependencies will only be
|
|
630
675
|
available in your build environment but will not be fetched when this
|
|
@@ -635,364 +680,403 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
635
680
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
636
681
|
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
637
682
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
638
|
-
|
|
639
|
-
<
|
|
683
|
+
</div>
|
|
684
|
+
<div class="tsd-comment tsd-typography">
|
|
685
|
+
<h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[ </span><span class="hl-2">'typescript'</span><span class="hl-1">, </span><span class="hl-2">'@types/express'</span><span class="hl-1"> ]</span>
|
|
640
686
|
</code><button>Copy</button></pre>
|
|
641
687
|
|
|
642
|
-
<
|
|
688
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
643
689
|
</code><button>Copy</button></pre>
|
|
644
690
|
|
|
645
|
-
<
|
|
691
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
646
692
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devDeps</p></aside></section>
|
|
647
693
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfig" class="tsd-anchor"></a>
|
|
648
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>disable<wbr/>Tsconfig</span><a href="#disableTsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
694
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>disable<wbr/>Tsconfig</span><a href="#disableTsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
649
695
|
<div class="tsd-signature"><span class="tsd-kind-property">disable<wbr/>Tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
650
696
|
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.json</code> file (used by jsii projects since
|
|
651
697
|
tsconfig.json is generated by the jsii compiler).</p>
|
|
652
|
-
|
|
653
|
-
<
|
|
698
|
+
</div>
|
|
699
|
+
<div class="tsd-comment tsd-typography">
|
|
700
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
654
701
|
</code><button>Copy</button></pre>
|
|
655
702
|
</div><aside class="tsd-sources">
|
|
656
703
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfig</p></aside></section>
|
|
657
704
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfigDev" class="tsd-anchor"></a>
|
|
658
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>disable<wbr/>Tsconfig<wbr/>Dev</span><a href="#disableTsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
705
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>disable<wbr/>Tsconfig<wbr/>Dev</span><a href="#disableTsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
659
706
|
<div class="tsd-signature"><span class="tsd-kind-property">disable<wbr/>Tsconfig<wbr/>Dev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
660
707
|
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.dev.json</code> file.</p>
|
|
661
|
-
|
|
662
|
-
<
|
|
708
|
+
</div>
|
|
709
|
+
<div class="tsd-comment tsd-typography">
|
|
710
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
663
711
|
</code><button>Copy</button></pre>
|
|
664
712
|
</div><aside class="tsd-sources">
|
|
665
713
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfigDev</p></aside></section>
|
|
666
714
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a>
|
|
667
|
-
<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
|
|
715
|
+
<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>
|
|
668
716
|
<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>
|
|
669
717
|
<div class="tsd-comment tsd-typography"><p>Docgen by Typedoc</p>
|
|
670
|
-
|
|
671
|
-
<
|
|
718
|
+
</div>
|
|
719
|
+
<div class="tsd-comment tsd-typography">
|
|
720
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
672
721
|
</code><button>Copy</button></pre>
|
|
673
722
|
</div><aside class="tsd-sources">
|
|
674
723
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docgen</p></aside></section>
|
|
675
724
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsDirectory" class="tsd-anchor"></a>
|
|
676
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>docs<wbr/>Directory</span><a href="#docsDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
725
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
677
726
|
<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>
|
|
678
727
|
<div class="tsd-comment tsd-typography"><p>Docs directory</p>
|
|
679
|
-
|
|
680
|
-
<
|
|
728
|
+
</div>
|
|
729
|
+
<div class="tsd-comment tsd-typography">
|
|
730
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"docs"</span>
|
|
681
731
|
</code><button>Copy</button></pre>
|
|
682
732
|
</div><aside class="tsd-sources">
|
|
683
733
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docsDirectory</p></aside></section>
|
|
684
734
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="edgeLambdaAutoDiscover" class="tsd-anchor"></a>
|
|
685
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><a href="#edgeLambdaAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
735
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><a href="#edgeLambdaAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
686
736
|
<div class="tsd-signature"><span class="tsd-kind-property">edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
687
737
|
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>cloudfront.experimental.EdgeFunction</code> for each
|
|
688
738
|
<code>.edge-lambda.ts</code> handler in your source tree. If this is disabled, you can
|
|
689
739
|
manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
690
|
-
|
|
691
|
-
<
|
|
740
|
+
</div>
|
|
741
|
+
<div class="tsd-comment tsd-typography">
|
|
742
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
692
743
|
</code><button>Copy</button></pre>
|
|
693
744
|
</div><aside class="tsd-sources">
|
|
694
745
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.edgeLambdaAutoDiscover</p></aside></section>
|
|
695
746
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" class="tsd-anchor"></a>
|
|
696
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entrypoint</span><a href="#entrypoint" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
747
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
697
748
|
<div class="tsd-signature"><span class="tsd-kind-property">entrypoint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
698
749
|
<div class="tsd-comment tsd-typography"><p>Module entrypoint (<code>main</code> in <code>package.json</code>)</p>
|
|
699
750
|
<p>Set to an empty string to not include <code>main</code> in your package.json</p>
|
|
700
|
-
|
|
701
|
-
<
|
|
751
|
+
</div>
|
|
752
|
+
<div class="tsd-comment tsd-typography">
|
|
753
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"lib/index.js"</span>
|
|
702
754
|
</code><button>Copy</button></pre>
|
|
703
755
|
</div><aside class="tsd-sources">
|
|
704
756
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypoint</p></aside></section>
|
|
705
757
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypointTypes" class="tsd-anchor"></a>
|
|
706
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entrypoint<wbr/>Types</span><a href="#entrypointTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
758
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>entrypoint<wbr/>Types</span><a href="#entrypointTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
707
759
|
<div class="tsd-signature"><span class="tsd-kind-property">entrypoint<wbr/>Types</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
708
760
|
<div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
|
|
709
|
-
|
|
710
|
-
<
|
|
761
|
+
</div>
|
|
762
|
+
<div class="tsd-comment tsd-typography">
|
|
763
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- .</span><span class="hl-4">d</span><span class="hl-1">.</span><span class="hl-4">ts</span><span class="hl-1"> </span><span class="hl-4">file</span><span class="hl-1"> </span><span class="hl-4">derived</span><span class="hl-1"> </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-2">'s entrypoint (usually lib/index.d.ts</span><span class="hl-8">)</span>
|
|
711
764
|
</code><button>Copy</button></pre>
|
|
712
765
|
</div><aside class="tsd-sources">
|
|
713
766
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypointTypes</p></aside></section>
|
|
714
767
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a>
|
|
715
|
-
<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
|
|
768
|
+
<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>
|
|
716
769
|
<div class="tsd-signature"><span class="tsd-kind-property">eslint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
717
770
|
<div class="tsd-comment tsd-typography"><p>Setup eslint.</p>
|
|
718
|
-
|
|
719
|
-
<
|
|
771
|
+
</div>
|
|
772
|
+
<div class="tsd-comment tsd-typography">
|
|
773
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
720
774
|
</code><button>Copy</button></pre>
|
|
721
775
|
</div><aside class="tsd-sources">
|
|
722
776
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslint</p></aside></section>
|
|
723
777
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslintOptions" class="tsd-anchor"></a>
|
|
724
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint<wbr/>Options</span><a href="#eslintOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
778
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>eslint<wbr/>Options</span><a href="#eslintOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
725
779
|
<div class="tsd-signature"><span class="tsd-kind-property">eslint<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">EslintOptions</span></div>
|
|
726
780
|
<div class="tsd-comment tsd-typography"><p>Eslint options</p>
|
|
727
|
-
|
|
728
|
-
<
|
|
781
|
+
</div>
|
|
782
|
+
<div class="tsd-comment tsd-typography">
|
|
783
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">opinionated</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
729
784
|
</code><button>Copy</button></pre>
|
|
730
785
|
</div><aside class="tsd-sources">
|
|
731
786
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslintOptions</p></aside></section>
|
|
732
787
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="featureFlags" class="tsd-anchor"></a>
|
|
733
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>feature<wbr/>Flags</span><a href="#featureFlags" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
788
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>feature<wbr/>Flags</span><a href="#featureFlags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
734
789
|
<div class="tsd-signature"><span class="tsd-kind-property">feature<wbr/>Flags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
735
790
|
<div class="tsd-comment tsd-typography"><p>Include all feature flags in cdk.json</p>
|
|
736
|
-
|
|
737
|
-
<
|
|
791
|
+
</div>
|
|
792
|
+
<div class="tsd-comment tsd-typography">
|
|
793
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
738
794
|
</code><button>Copy</button></pre>
|
|
739
795
|
</div><aside class="tsd-sources">
|
|
740
796
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.featureFlags</p></aside></section>
|
|
741
797
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitIgnoreOptions" class="tsd-anchor"></a>
|
|
742
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>git<wbr/>Ignore<wbr/>Options</span><a href="#gitIgnoreOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
798
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>git<wbr/>Ignore<wbr/>Options</span><a href="#gitIgnoreOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
743
799
|
<div class="tsd-signature"><span class="tsd-kind-property">git<wbr/>Ignore<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IgnoreFileOptions</span></div>
|
|
744
800
|
<div class="tsd-comment tsd-typography"><p>Configuration options for .gitignore file</p>
|
|
745
|
-
</div
|
|
801
|
+
</div>
|
|
802
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
746
803
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitIgnoreOptions</p></aside></section>
|
|
747
804
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitOptions" class="tsd-anchor"></a>
|
|
748
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>git<wbr/>Options</span><a href="#gitOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
805
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>git<wbr/>Options</span><a href="#gitOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
749
806
|
<div class="tsd-signature"><span class="tsd-kind-property">git<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GitOptions</span></div>
|
|
750
807
|
<div class="tsd-comment tsd-typography"><p>Configuration options for git</p>
|
|
751
|
-
</div
|
|
808
|
+
</div>
|
|
809
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
752
810
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitOptions</p></aside></section>
|
|
753
811
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="github" class="tsd-anchor"></a>
|
|
754
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github</span><a href="#github" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
812
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
755
813
|
<div class="tsd-signature"><span class="tsd-kind-property">github</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
756
814
|
<div class="tsd-comment tsd-typography"><p>Enable GitHub integration.</p>
|
|
757
815
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
758
|
-
|
|
759
|
-
<
|
|
816
|
+
</div>
|
|
817
|
+
<div class="tsd-comment tsd-typography">
|
|
818
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
760
819
|
</code><button>Copy</button></pre>
|
|
761
820
|
</div><aside class="tsd-sources">
|
|
762
821
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.github</p></aside></section>
|
|
763
822
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="githubOptions" class="tsd-anchor"></a>
|
|
764
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github<wbr/>Options</span><a href="#githubOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
823
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>github<wbr/>Options</span><a href="#githubOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
765
824
|
<div class="tsd-signature"><span class="tsd-kind-property">github<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GitHubOptions</span></div>
|
|
766
825
|
<div class="tsd-comment tsd-typography"><p>Options for GitHub integration</p>
|
|
767
|
-
|
|
768
|
-
<
|
|
826
|
+
</div>
|
|
827
|
+
<div class="tsd-comment tsd-typography">
|
|
828
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">see</span><span class="hl-1"> </span><span class="hl-4">GitHubOptions</span>
|
|
769
829
|
</code><button>Copy</button></pre>
|
|
770
830
|
</div><aside class="tsd-sources">
|
|
771
831
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.githubOptions</p></aside></section>
|
|
772
832
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a>
|
|
773
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitignore</span><a href="#gitignore" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
833
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
774
834
|
<div class="tsd-signature"><span class="tsd-kind-property">gitignore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
775
835
|
<div class="tsd-comment tsd-typography"><p>Additional entries to .gitignore</p>
|
|
776
|
-
</div
|
|
836
|
+
</div>
|
|
837
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
777
838
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitignore</p></aside></section>
|
|
778
839
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitpod" class="tsd-anchor"></a>
|
|
779
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>gitpod</span><a href="#gitpod" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
840
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
780
841
|
<div class="tsd-signature"><span class="tsd-kind-property">gitpod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
781
842
|
<div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment</p>
|
|
782
|
-
|
|
783
|
-
<
|
|
843
|
+
</div>
|
|
844
|
+
<div class="tsd-comment tsd-typography">
|
|
845
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
784
846
|
</code><button>Copy</button></pre>
|
|
785
847
|
</div><aside class="tsd-sources">
|
|
786
848
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitpod</p></aside></section>
|
|
787
849
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="homepage" class="tsd-anchor"></a>
|
|
788
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>homepage</span><a href="#homepage" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
850
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>homepage</span><a href="#homepage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
789
851
|
<div class="tsd-signature"><span class="tsd-kind-property">homepage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
790
852
|
<div class="tsd-comment tsd-typography"><p>Package's Homepage / Website</p>
|
|
791
|
-
</div
|
|
853
|
+
</div>
|
|
854
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
792
855
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.homepage</p></aside></section>
|
|
793
856
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="integrationTestAutoDiscover" class="tsd-anchor"></a>
|
|
794
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span><a href="#integrationTestAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
857
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span><a href="#integrationTestAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
795
858
|
<div class="tsd-signature"><span class="tsd-kind-property">integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
796
859
|
<div class="tsd-comment tsd-typography"><p>Automatically discovers and creates integration tests for each <code>.integ.ts</code>
|
|
797
860
|
file in under your test directory.</p>
|
|
798
|
-
|
|
799
|
-
<
|
|
861
|
+
</div>
|
|
862
|
+
<div class="tsd-comment tsd-typography">
|
|
863
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
800
864
|
</code><button>Copy</button></pre>
|
|
801
865
|
</div><aside class="tsd-sources">
|
|
802
866
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.integrationTestAutoDiscover</p></aside></section>
|
|
803
867
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jest" class="tsd-anchor"></a>
|
|
804
|
-
<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
|
|
868
|
+
<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>
|
|
805
869
|
<div class="tsd-signature"><span class="tsd-kind-property">jest</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
806
870
|
<div class="tsd-comment tsd-typography"><p>Setup jest unit tests</p>
|
|
807
|
-
|
|
808
|
-
<
|
|
871
|
+
</div>
|
|
872
|
+
<div class="tsd-comment tsd-typography">
|
|
873
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
809
874
|
</code><button>Copy</button></pre>
|
|
810
875
|
</div><aside class="tsd-sources">
|
|
811
876
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jest</p></aside></section>
|
|
812
877
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jestOptions" class="tsd-anchor"></a>
|
|
813
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jest<wbr/>Options</span><a href="#jestOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
878
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jest<wbr/>Options</span><a href="#jestOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
814
879
|
<div class="tsd-signature"><span class="tsd-kind-property">jest<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JestOptions</span></div>
|
|
815
880
|
<div class="tsd-comment tsd-typography"><p>Jest options</p>
|
|
816
|
-
|
|
817
|
-
<
|
|
881
|
+
</div>
|
|
882
|
+
<div class="tsd-comment tsd-typography">
|
|
883
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
818
884
|
</code><button>Copy</button></pre>
|
|
819
885
|
</div><aside class="tsd-sources">
|
|
820
886
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jestOptions</p></aside></section>
|
|
821
887
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jsiiReleaseVersion" class="tsd-anchor"></a>
|
|
822
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jsii<wbr/>Release<wbr/>Version</span><a href="#jsiiReleaseVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
888
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>jsii<wbr/>Release<wbr/>Version</span><a href="#jsiiReleaseVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
823
889
|
<div class="tsd-signature"><span class="tsd-kind-property">jsii<wbr/>Release<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
824
890
|
<div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
825
|
-
|
|
826
|
-
<
|
|
891
|
+
</div>
|
|
892
|
+
<div class="tsd-comment tsd-typography">
|
|
893
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"latest"</span>
|
|
827
894
|
</code><button>Copy</button></pre>
|
|
828
895
|
</div><aside class="tsd-sources">
|
|
829
896
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jsiiReleaseVersion</p></aside></section>
|
|
830
897
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keywords" class="tsd-anchor"></a>
|
|
831
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>keywords</span><a href="#keywords" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
898
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>keywords</span><a href="#keywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
832
899
|
<div class="tsd-signature"><span class="tsd-kind-property">keywords</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
833
900
|
<div class="tsd-comment tsd-typography"><p>Keywords to include in <code>package.json</code>.</p>
|
|
834
|
-
</div
|
|
901
|
+
</div>
|
|
902
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
835
903
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.keywords</p></aside></section>
|
|
836
904
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaAutoDiscover" class="tsd-anchor"></a>
|
|
837
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Auto<wbr/>Discover</span><a href="#lambdaAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
905
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Auto<wbr/>Discover</span><a href="#lambdaAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
838
906
|
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
839
907
|
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaFunction</code> for each <code>.lambda.ts</code> handler
|
|
840
908
|
in your source tree. If this is disabled, you can manually add an
|
|
841
909
|
<code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
842
|
-
|
|
843
|
-
<
|
|
910
|
+
</div>
|
|
911
|
+
<div class="tsd-comment tsd-typography">
|
|
912
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
844
913
|
</code><button>Copy</button></pre>
|
|
845
914
|
</div><aside class="tsd-sources">
|
|
846
915
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaAutoDiscover</p></aside></section>
|
|
847
916
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaExtensionAutoDiscover" class="tsd-anchor"></a>
|
|
848
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span><a href="#lambdaExtensionAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
917
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span><a href="#lambdaExtensionAutoDiscover" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
849
918
|
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
850
919
|
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaExtension</code> for each <code>.lambda-extension.ts</code>
|
|
851
920
|
entrypoint in your source tree. If this is disabled, you can manually add an
|
|
852
921
|
<code>awscdk.AutoDiscover</code> component to your project</p>
|
|
853
|
-
|
|
854
|
-
<
|
|
922
|
+
</div>
|
|
923
|
+
<div class="tsd-comment tsd-typography">
|
|
924
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
855
925
|
</code><button>Copy</button></pre>
|
|
856
926
|
</div><aside class="tsd-sources">
|
|
857
927
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaExtensionAutoDiscover</p></aside></section>
|
|
858
928
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
859
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
929
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
860
930
|
<div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">LambdaFunctionCommonOptions</span></div>
|
|
861
931
|
<div class="tsd-comment tsd-typography"><p>Common options for all AWS Lambda functions.</p>
|
|
862
|
-
|
|
863
|
-
<
|
|
932
|
+
</div>
|
|
933
|
+
<div class="tsd-comment tsd-typography">
|
|
934
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
864
935
|
</code><button>Copy</button></pre>
|
|
865
936
|
</div><aside class="tsd-sources">
|
|
866
937
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaOptions</p></aside></section>
|
|
867
938
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="libdir" class="tsd-anchor"></a>
|
|
868
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
939
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
869
940
|
<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>
|
|
870
941
|
<div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory</p>
|
|
871
|
-
|
|
872
|
-
<
|
|
942
|
+
</div>
|
|
943
|
+
<div class="tsd-comment tsd-typography">
|
|
944
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"lib"</span>
|
|
873
945
|
</code><button>Copy</button></pre>
|
|
874
946
|
</div><aside class="tsd-sources">
|
|
875
947
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.libdir</p></aside></section>
|
|
876
948
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="license" class="tsd-anchor"></a>
|
|
877
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>license</span><a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
949
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>license</span><a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
878
950
|
<div class="tsd-signature"><span class="tsd-kind-property">license</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
879
951
|
<div class="tsd-comment tsd-typography"><p>License's SPDX identifier.
|
|
880
952
|
See <a href="https://github.com/projen/projen/tree/main/license-text">https://github.com/projen/projen/tree/main/license-text</a> for a list of supported licenses.
|
|
881
953
|
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
882
|
-
|
|
883
|
-
<
|
|
954
|
+
</div>
|
|
955
|
+
<div class="tsd-comment tsd-typography">
|
|
956
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"Apache-2.0"</span>
|
|
884
957
|
</code><button>Copy</button></pre>
|
|
885
958
|
</div><aside class="tsd-sources">
|
|
886
959
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.license</p></aside></section>
|
|
887
960
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="licensed" class="tsd-anchor"></a>
|
|
888
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>licensed</span><a href="#licensed" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
961
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>licensed</span><a href="#licensed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
889
962
|
<div class="tsd-signature"><span class="tsd-kind-property">licensed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
890
963
|
<div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
891
|
-
|
|
892
|
-
<
|
|
964
|
+
</div>
|
|
965
|
+
<div class="tsd-comment tsd-typography">
|
|
966
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
893
967
|
</code><button>Copy</button></pre>
|
|
894
968
|
</div><aside class="tsd-sources">
|
|
895
969
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.licensed</p></aside></section>
|
|
896
970
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logging" class="tsd-anchor"></a>
|
|
897
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logging</span><a href="#logging" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
971
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logging</span><a href="#logging" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
898
972
|
<div class="tsd-signature"><span class="tsd-kind-property">logging</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">LoggerOptions</span></div>
|
|
899
973
|
<div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
900
|
-
|
|
901
|
-
<
|
|
974
|
+
</div>
|
|
975
|
+
<div class="tsd-comment tsd-typography">
|
|
976
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">{}</span>
|
|
902
977
|
</code><button>Copy</button></pre>
|
|
903
978
|
</div><aside class="tsd-sources">
|
|
904
979
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.logging</p></aside></section>
|
|
905
980
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="majorVersion" class="tsd-anchor"></a>
|
|
906
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>major<wbr/>Version</span><a href="#majorVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
981
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>major<wbr/>Version</span><a href="#majorVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
907
982
|
<div class="tsd-signature"><span class="tsd-kind-property">major<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
908
983
|
<div class="tsd-comment tsd-typography"><p>Major version to release from the default branch.</p>
|
|
909
984
|
<p>If this is specified, we bump the latest version of this major version line.
|
|
910
985
|
If not specified, we bump the global latest version.</p>
|
|
911
|
-
|
|
912
|
-
<
|
|
986
|
+
</div>
|
|
987
|
+
<div class="tsd-comment tsd-typography">
|
|
988
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">Major</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">enforced</span><span class="hl-1">.</span>
|
|
913
989
|
</code><button>Copy</button></pre>
|
|
914
990
|
</div><aside class="tsd-sources">
|
|
915
991
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.majorVersion</p></aside></section>
|
|
916
992
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" class="tsd-anchor"></a>
|
|
917
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max<wbr/>Node<wbr/>Version</span><a href="#maxNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
993
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
918
994
|
<div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
919
995
|
<div class="tsd-comment tsd-typography"><p>Minimum node.js version to require via <code>engines</code> (inclusive).</p>
|
|
920
|
-
|
|
921
|
-
<
|
|
996
|
+
</div>
|
|
997
|
+
<div class="tsd-comment tsd-typography">
|
|
998
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">max</span>
|
|
922
999
|
</code><button>Copy</button></pre>
|
|
923
1000
|
</div><aside class="tsd-sources">
|
|
924
1001
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.maxNodeVersion</p></aside></section>
|
|
925
1002
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergify" class="tsd-anchor"></a>
|
|
926
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">mergify</span><a href="#mergify" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1003
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">mergify</span><a href="#mergify" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
927
1004
|
<div class="tsd-signature"><span class="tsd-kind-property">mergify</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
928
1005
|
<div class="tsd-comment tsd-typography"><p>Whether mergify should be enabled on this repository or not.</p>
|
|
929
|
-
|
|
930
|
-
<
|
|
1006
|
+
</div>
|
|
1007
|
+
<div class="tsd-comment tsd-typography">
|
|
1008
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
931
1009
|
</code><button>Copy</button></pre>
|
|
932
1010
|
|
|
933
|
-
<
|
|
1011
|
+
<h4>Deprecated</h4><p>use <code>githubOptions.mergify</code> instead</p>
|
|
934
1012
|
</div><aside class="tsd-sources">
|
|
935
1013
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergify</p></aside></section>
|
|
936
1014
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergifyOptions" class="tsd-anchor"></a>
|
|
937
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">mergify<wbr/>Options</span><a href="#mergifyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1015
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">mergify<wbr/>Options</span><a href="#mergifyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
938
1016
|
<div class="tsd-signature"><span class="tsd-kind-property">mergify<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">MergifyOptions</span></div>
|
|
939
1017
|
<div class="tsd-comment tsd-typography"><p>Options for mergify</p>
|
|
940
|
-
|
|
941
|
-
<
|
|
1018
|
+
</div>
|
|
1019
|
+
<div class="tsd-comment tsd-typography">
|
|
1020
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
942
1021
|
</code><button>Copy</button></pre>
|
|
943
1022
|
|
|
944
|
-
<
|
|
1023
|
+
<h4>Deprecated</h4><p>use <code>githubOptions.mergifyOptions</code> instead</p>
|
|
945
1024
|
</div><aside class="tsd-sources">
|
|
946
1025
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergifyOptions</p></aside></section>
|
|
947
1026
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minMajorVersion" class="tsd-anchor"></a>
|
|
948
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>min<wbr/>Major<wbr/>Version</span><a href="#minMajorVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1027
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>min<wbr/>Major<wbr/>Version</span><a href="#minMajorVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
949
1028
|
<div class="tsd-signature"><span class="tsd-kind-property">min<wbr/>Major<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
950
1029
|
<div class="tsd-comment tsd-typography"><p>Minimal Major version to release</p>
|
|
951
1030
|
<p>This can be useful to set to 1, as breaking changes before the 1.x major
|
|
952
1031
|
release are not incrementing the major version number.</p>
|
|
953
1032
|
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
954
|
-
|
|
955
|
-
<
|
|
1033
|
+
</div>
|
|
1034
|
+
<div class="tsd-comment tsd-typography">
|
|
1035
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">No</span><span class="hl-1"> </span><span class="hl-4">minimum</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">being</span><span class="hl-1"> </span><span class="hl-4">enforced</span>
|
|
956
1036
|
</code><button>Copy</button></pre>
|
|
957
1037
|
</div><aside class="tsd-sources">
|
|
958
1038
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minMajorVersion</p></aside></section>
|
|
959
1039
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" class="tsd-anchor"></a>
|
|
960
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>min<wbr/>Node<wbr/>Version</span><a href="#minNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1040
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
961
1041
|
<div class="tsd-signature"><span class="tsd-kind-property">min<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
962
1042
|
<div class="tsd-comment tsd-typography"><p>Minimum Node.js version to require via package.json <code>engines</code> (inclusive).</p>
|
|
963
|
-
|
|
964
|
-
<
|
|
1043
|
+
</div>
|
|
1044
|
+
<div class="tsd-comment tsd-typography">
|
|
1045
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-2">"engines"</span><span class="hl-1"> </span><span class="hl-4">specified</span>
|
|
965
1046
|
</code><button>Copy</button></pre>
|
|
966
1047
|
</div><aside class="tsd-sources">
|
|
967
1048
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minNodeVersion</p></aside></section>
|
|
968
1049
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mutableBuild" class="tsd-anchor"></a>
|
|
969
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>mutable<wbr/>Build</span><a href="#mutableBuild" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1050
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>mutable<wbr/>Build</span><a href="#mutableBuild" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
970
1051
|
<div class="tsd-signature"><span class="tsd-kind-property">mutable<wbr/>Build</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
971
1052
|
<div class="tsd-comment tsd-typography"><p>Automatically update files modified during builds to pull-request branches. This means
|
|
972
1053
|
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
973
1054
|
before a PR is merged.</p>
|
|
974
1055
|
<p>Implies that PR builds do not have anti-tamper checks.</p>
|
|
975
|
-
|
|
976
|
-
<
|
|
1056
|
+
</div>
|
|
1057
|
+
<div class="tsd-comment tsd-typography">
|
|
1058
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
977
1059
|
</code><button>Copy</button></pre>
|
|
978
1060
|
</div><aside class="tsd-sources">
|
|
979
1061
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mutableBuild</p></aside></section>
|
|
980
1062
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
|
|
981
|
-
<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
|
|
1063
|
+
<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>
|
|
982
1064
|
<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>
|
|
983
1065
|
<div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
984
|
-
|
|
985
|
-
<
|
|
1066
|
+
</div>
|
|
1067
|
+
<div class="tsd-comment tsd-typography">
|
|
1068
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">$BASEDIR</span>
|
|
986
1069
|
</code><button>Copy</button></pre>
|
|
987
1070
|
|
|
988
|
-
<
|
|
1071
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
989
1072
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.name</p></aside></section>
|
|
990
1073
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmAccess" class="tsd-anchor"></a>
|
|
991
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Access</span><a href="#npmAccess" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1074
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Access</span><a href="#npmAccess" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
992
1075
|
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Access</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">NpmAccess</span></div>
|
|
993
1076
|
<div class="tsd-comment tsd-typography"><p>Access level of the npm package.</p>
|
|
994
|
-
|
|
995
|
-
<
|
|
1077
|
+
</div>
|
|
1078
|
+
<div class="tsd-comment tsd-typography">
|
|
1079
|
+
<h4>Default</h4><ul>
|
|
996
1080
|
<li>for scoped packages (e.g. <code>foo@bar</code>), the default is
|
|
997
1081
|
<code>NpmAccess.RESTRICTED</code>, for non-scoped packages, the default is
|
|
998
1082
|
<code>NpmAccess.PUBLIC</code>.</li>
|
|
@@ -1000,125 +1084,138 @@ before a PR is merged.</p>
|
|
|
1000
1084
|
</div><aside class="tsd-sources">
|
|
1001
1085
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmAccess</p></aside></section>
|
|
1002
1086
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmDistTag" class="tsd-anchor"></a>
|
|
1003
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Dist<wbr/>Tag</span><a href="#npmDistTag" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1087
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Dist<wbr/>Tag</span><a href="#npmDistTag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1004
1088
|
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Dist<wbr/>Tag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1005
1089
|
<div class="tsd-comment tsd-typography"><p>The npmDistTag to use when publishing from the default branch.</p>
|
|
1006
1090
|
<p>To set the npm dist-tag for release branches, set the <code>npmDistTag</code> property
|
|
1007
1091
|
for each branch.</p>
|
|
1008
|
-
|
|
1009
|
-
<
|
|
1092
|
+
</div>
|
|
1093
|
+
<div class="tsd-comment tsd-typography">
|
|
1094
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"latest"</span>
|
|
1010
1095
|
</code><button>Copy</button></pre>
|
|
1011
1096
|
</div><aside class="tsd-sources">
|
|
1012
1097
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmDistTag</p></aside></section>
|
|
1013
1098
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmIgnoreOptions" class="tsd-anchor"></a>
|
|
1014
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Ignore<wbr/>Options</span><a href="#npmIgnoreOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1099
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Ignore<wbr/>Options</span><a href="#npmIgnoreOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1015
1100
|
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Ignore<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IgnoreFileOptions</span></div>
|
|
1016
1101
|
<div class="tsd-comment tsd-typography"><p>Configuration options for .npmignore file</p>
|
|
1017
|
-
</div
|
|
1102
|
+
</div>
|
|
1103
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1018
1104
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmIgnoreOptions</p></aside></section>
|
|
1019
1105
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmRegistry" class="tsd-anchor"></a>
|
|
1020
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">npm<wbr/>Registry</span><a href="#npmRegistry" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1106
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">npm<wbr/>Registry</span><a href="#npmRegistry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1021
1107
|
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Registry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1022
1108
|
<div class="tsd-comment tsd-typography"><p>The host name of the npm registry to publish to. Cannot be set together with <code>npmRegistryUrl</code>.</p>
|
|
1023
|
-
|
|
1024
|
-
<
|
|
1109
|
+
</div>
|
|
1110
|
+
<div class="tsd-comment tsd-typography">
|
|
1111
|
+
<h4>Deprecated</h4><p>use <code>npmRegistryUrl</code> instead</p>
|
|
1025
1112
|
</div><aside class="tsd-sources">
|
|
1026
1113
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistry</p></aside></section>
|
|
1027
1114
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmRegistryUrl" class="tsd-anchor"></a>
|
|
1028
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Registry<wbr/>Url</span><a href="#npmRegistryUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1115
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Registry<wbr/>Url</span><a href="#npmRegistryUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1029
1116
|
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Registry<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1030
1117
|
<div class="tsd-comment tsd-typography"><p>The base URL of the npm package registry.</p>
|
|
1031
1118
|
<p>Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
1032
|
-
|
|
1033
|
-
<
|
|
1119
|
+
</div>
|
|
1120
|
+
<div class="tsd-comment tsd-typography">
|
|
1121
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"https://registry.npmjs.org"</span>
|
|
1034
1122
|
</code><button>Copy</button></pre>
|
|
1035
1123
|
</div><aside class="tsd-sources">
|
|
1036
1124
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistryUrl</p></aside></section>
|
|
1037
1125
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmTokenSecret" class="tsd-anchor"></a>
|
|
1038
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Token<wbr/>Secret</span><a href="#npmTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1126
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npm<wbr/>Token<wbr/>Secret</span><a href="#npmTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1039
1127
|
<div class="tsd-signature"><span class="tsd-kind-property">npm<wbr/>Token<wbr/>Secret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1040
1128
|
<div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
1041
|
-
|
|
1042
|
-
<
|
|
1129
|
+
</div>
|
|
1130
|
+
<div class="tsd-comment tsd-typography">
|
|
1131
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"NPM_TOKEN"</span>
|
|
1043
1132
|
</code><button>Copy</button></pre>
|
|
1044
1133
|
</div><aside class="tsd-sources">
|
|
1045
1134
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmTokenSecret</p></aside></section>
|
|
1046
1135
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a>
|
|
1047
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">npmignore</span><a href="#npmignore" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1136
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">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>
|
|
1048
1137
|
<div class="tsd-signature"><span class="tsd-kind-property">npmignore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1049
1138
|
<div class="tsd-comment tsd-typography"><p>Additional entries to .npmignore.</p>
|
|
1050
|
-
|
|
1051
|
-
<
|
|
1139
|
+
</div>
|
|
1140
|
+
<div class="tsd-comment tsd-typography">
|
|
1141
|
+
<h4>Deprecated</h4><ul>
|
|
1052
1142
|
<li>use <code>project.addPackageIgnore</code></li>
|
|
1053
1143
|
</ul>
|
|
1054
1144
|
</div><aside class="tsd-sources">
|
|
1055
1145
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignore</p></aside></section>
|
|
1056
1146
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignoreEnabled" class="tsd-anchor"></a>
|
|
1057
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npmignore<wbr/>Enabled</span><a href="#npmignoreEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1147
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>npmignore<wbr/>Enabled</span><a href="#npmignoreEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1058
1148
|
<div class="tsd-signature"><span class="tsd-kind-property">npmignore<wbr/>Enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1059
1149
|
<div class="tsd-comment tsd-typography"><p>Defines an .npmignore file. Normally this is only needed for libraries that
|
|
1060
1150
|
are packaged as tarballs.</p>
|
|
1061
|
-
|
|
1062
|
-
<
|
|
1151
|
+
</div>
|
|
1152
|
+
<div class="tsd-comment tsd-typography">
|
|
1153
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1063
1154
|
</code><button>Copy</button></pre>
|
|
1064
1155
|
</div><aside class="tsd-sources">
|
|
1065
1156
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignoreEnabled</p></aside></section>
|
|
1066
1157
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
1067
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>outdir</span><a href="#outdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1158
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1068
1159
|
<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>
|
|
1069
1160
|
<div class="tsd-comment tsd-typography"><p>The root directory of the project.</p>
|
|
1070
1161
|
<p>Relative to this directory, all files are synthesized.</p>
|
|
1071
1162
|
<p>If this project has a parent, this directory is relative to the parent
|
|
1072
1163
|
directory and it cannot be the same as the parent or any of it's other
|
|
1073
1164
|
sub-projects.</p>
|
|
1074
|
-
|
|
1075
|
-
<
|
|
1165
|
+
</div>
|
|
1166
|
+
<div class="tsd-comment tsd-typography">
|
|
1167
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"."</span>
|
|
1076
1168
|
</code><button>Copy</button></pre>
|
|
1077
1169
|
</div><aside class="tsd-sources">
|
|
1078
1170
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.outdir</p></aside></section>
|
|
1079
1171
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a>
|
|
1080
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1172
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1081
1173
|
<div class="tsd-signature"><span class="tsd-kind-property">package</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1082
1174
|
<div class="tsd-comment tsd-typography"><p>Defines a <code>package</code> task that will produce an npm tarball under the
|
|
1083
1175
|
artifacts directory (e.g. <code>dist</code>).</p>
|
|
1084
|
-
|
|
1085
|
-
<
|
|
1176
|
+
</div>
|
|
1177
|
+
<div class="tsd-comment tsd-typography">
|
|
1178
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1086
1179
|
</code><button>Copy</button></pre>
|
|
1087
1180
|
</div><aside class="tsd-sources">
|
|
1088
1181
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.package</p></aside></section>
|
|
1089
1182
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
1090
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package<wbr/>Manager</span><a href="#packageManager" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1183
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
|
|
1091
1184
|
<div class="tsd-signature"><span class="tsd-kind-property">package<wbr/>Manager</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">NodePackageManager</span></div>
|
|
1092
1185
|
<div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts</p>
|
|
1093
|
-
|
|
1094
|
-
<
|
|
1186
|
+
</div>
|
|
1187
|
+
<div class="tsd-comment tsd-typography">
|
|
1188
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">NodePackageManager</span><span class="hl-1">.</span><span class="hl-6">YARN</span>
|
|
1095
1189
|
</code><button>Copy</button></pre>
|
|
1096
1190
|
</div><aside class="tsd-sources">
|
|
1097
1191
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageManager</p></aside></section>
|
|
1098
1192
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageName" class="tsd-anchor"></a>
|
|
1099
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package<wbr/>Name</span><a href="#packageName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1193
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>package<wbr/>Name</span><a href="#packageName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1100
1194
|
<div class="tsd-signature"><span class="tsd-kind-property">package<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1101
1195
|
<div class="tsd-comment tsd-typography"><p>The "name" in package.json</p>
|
|
1102
|
-
|
|
1103
|
-
<
|
|
1196
|
+
</div>
|
|
1197
|
+
<div class="tsd-comment tsd-typography">
|
|
1198
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">defaults</span><span class="hl-1"> </span><span class="hl-4">to</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-1"> </span><span class="hl-4">name</span>
|
|
1104
1199
|
</code><button>Copy</button></pre>
|
|
1105
1200
|
|
|
1106
|
-
<
|
|
1201
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
1107
1202
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageName</p></aside></section>
|
|
1108
1203
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="parent" class="tsd-anchor"></a>
|
|
1109
|
-
<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
|
|
1204
|
+
<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>
|
|
1110
1205
|
<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>
|
|
1111
1206
|
<div class="tsd-comment tsd-typography"><p>The parent project, if this project is part of a bigger project.</p>
|
|
1112
|
-
</div
|
|
1207
|
+
</div>
|
|
1208
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1113
1209
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.parent</p></aside></section>
|
|
1114
1210
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="peerDependencyOptions" class="tsd-anchor"></a>
|
|
1115
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>peer<wbr/>Dependency<wbr/>Options</span><a href="#peerDependencyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1211
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>peer<wbr/>Dependency<wbr/>Options</span><a href="#peerDependencyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1116
1212
|
<div class="tsd-signature"><span class="tsd-kind-property">peer<wbr/>Dependency<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">PeerDependencyOptions</span></div>
|
|
1117
1213
|
<div class="tsd-comment tsd-typography"><p>Options for <code>peerDeps</code>.</p>
|
|
1118
|
-
</div
|
|
1214
|
+
</div>
|
|
1215
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1119
1216
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDependencyOptions</p></aside></section>
|
|
1120
1217
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="peerDeps" class="tsd-anchor"></a>
|
|
1121
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>peer<wbr/>Deps</span><a href="#peerDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1218
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>peer<wbr/>Deps</span><a href="#peerDeps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1122
1219
|
<div class="tsd-signature"><span class="tsd-kind-property">peer<wbr/>Deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1123
1220
|
<div class="tsd-comment tsd-typography"><p>Peer dependencies for this module. Dependencies listed here are required to
|
|
1124
1221
|
be installed (and satisfied) by the <em>consumer</em> of this library. Using peer
|
|
@@ -1131,234 +1228,258 @@ breaking change for your customers.</p>
|
|
|
1131
1228
|
enabled by default), projen will automatically add a dev dependency with a
|
|
1132
1229
|
pinned version for each peer dependency. This will ensure that you build &
|
|
1133
1230
|
test your module against the lowest peer version required.</p>
|
|
1134
|
-
|
|
1135
|
-
<
|
|
1231
|
+
</div>
|
|
1232
|
+
<div class="tsd-comment tsd-typography">
|
|
1233
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
1136
1234
|
</code><button>Copy</button></pre>
|
|
1137
1235
|
</div><aside class="tsd-sources">
|
|
1138
1236
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDeps</p></aside></section>
|
|
1139
1237
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pnpmVersion" class="tsd-anchor"></a>
|
|
1140
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pnpm<wbr/>Version</span><a href="#pnpmVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1238
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pnpm<wbr/>Version</span><a href="#pnpmVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1141
1239
|
<div class="tsd-signature"><span class="tsd-kind-property">pnpm<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1142
1240
|
<div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
1143
|
-
|
|
1144
|
-
<
|
|
1241
|
+
</div>
|
|
1242
|
+
<div class="tsd-comment tsd-typography">
|
|
1243
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"7"</span>
|
|
1145
1244
|
</code><button>Copy</button></pre>
|
|
1146
1245
|
</div><aside class="tsd-sources">
|
|
1147
1246
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pnpmVersion</p></aside></section>
|
|
1148
1247
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postBuildSteps" class="tsd-anchor"></a>
|
|
1149
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>post<wbr/>Build<wbr/>Steps</span><a href="#postBuildSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1248
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>post<wbr/>Build<wbr/>Steps</span><a href="#postBuildSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1150
1249
|
<div class="tsd-signature"><span class="tsd-kind-property">post<wbr/>Build<wbr/>Steps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1151
1250
|
<div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
1152
|
-
|
|
1153
|
-
<
|
|
1251
|
+
</div>
|
|
1252
|
+
<div class="tsd-comment tsd-typography">
|
|
1253
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
1154
1254
|
</code><button>Copy</button></pre>
|
|
1155
1255
|
</div><aside class="tsd-sources">
|
|
1156
1256
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.postBuildSteps</p></aside></section>
|
|
1157
1257
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prerelease" class="tsd-anchor"></a>
|
|
1158
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prerelease</span><a href="#prerelease" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1258
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prerelease</span><a href="#prerelease" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1159
1259
|
<div class="tsd-signature"><span class="tsd-kind-property">prerelease</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1160
1260
|
<div class="tsd-comment tsd-typography"><p>Bump versions from the default branch as pre-releases (e.g. "beta",
|
|
1161
1261
|
"alpha", "pre").</p>
|
|
1162
|
-
|
|
1163
|
-
<
|
|
1262
|
+
</div>
|
|
1263
|
+
<div class="tsd-comment tsd-typography">
|
|
1264
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">normal</span><span class="hl-1"> </span><span class="hl-4">semantic</span><span class="hl-1"> </span><span class="hl-4">versions</span>
|
|
1164
1265
|
</code><button>Copy</button></pre>
|
|
1165
1266
|
</div><aside class="tsd-sources">
|
|
1166
1267
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prerelease</p></aside></section>
|
|
1167
1268
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" class="tsd-anchor"></a>
|
|
1168
|
-
<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
|
|
1269
|
+
<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>
|
|
1169
1270
|
<div class="tsd-signature"><span class="tsd-kind-property">prettier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1170
1271
|
<div class="tsd-comment tsd-typography"><p>Setup prettier.</p>
|
|
1171
|
-
|
|
1172
|
-
<
|
|
1272
|
+
</div>
|
|
1273
|
+
<div class="tsd-comment tsd-typography">
|
|
1274
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1173
1275
|
</code><button>Copy</button></pre>
|
|
1174
1276
|
</div><aside class="tsd-sources">
|
|
1175
1277
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettier</p></aside></section>
|
|
1176
1278
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettierOptions" class="tsd-anchor"></a>
|
|
1177
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier<wbr/>Options</span><a href="#prettierOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1279
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>prettier<wbr/>Options</span><a href="#prettierOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1178
1280
|
<div class="tsd-signature"><span class="tsd-kind-property">prettier<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">PrettierOptions</span></div>
|
|
1179
1281
|
<div class="tsd-comment tsd-typography"><p>Prettier options</p>
|
|
1180
|
-
|
|
1181
|
-
<
|
|
1282
|
+
</div>
|
|
1283
|
+
<div class="tsd-comment tsd-typography">
|
|
1284
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1182
1285
|
</code><button>Copy</button></pre>
|
|
1183
1286
|
</div><aside class="tsd-sources">
|
|
1184
1287
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettierOptions</p></aside></section>
|
|
1185
1288
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectType" class="tsd-anchor"></a>
|
|
1186
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">project<wbr/>Type</span><a href="#projectType" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1289
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">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>
|
|
1187
1290
|
<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>
|
|
1188
1291
|
<div class="tsd-comment tsd-typography"><p>Which type of project this is (library/app).</p>
|
|
1189
|
-
|
|
1190
|
-
<
|
|
1292
|
+
</div>
|
|
1293
|
+
<div class="tsd-comment tsd-typography">
|
|
1294
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ProjectType</span><span class="hl-1">.</span><span class="hl-6">UNKNOWN</span>
|
|
1191
1295
|
</code><button>Copy</button></pre>
|
|
1192
1296
|
|
|
1193
|
-
<
|
|
1297
|
+
<h4>Deprecated</h4><p>no longer supported at the base project level</p>
|
|
1194
1298
|
</div><aside class="tsd-sources">
|
|
1195
1299
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projectType</p></aside></section>
|
|
1196
1300
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCommand" class="tsd-anchor"></a>
|
|
1197
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Command</span><a href="#projenCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1301
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1198
1302
|
<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>
|
|
1199
1303
|
<div class="tsd-comment tsd-typography"><p>The shell command to use in order to run the projen CLI.</p>
|
|
1200
1304
|
<p>Can be used to customize in special environments.</p>
|
|
1201
|
-
|
|
1202
|
-
<
|
|
1305
|
+
</div>
|
|
1306
|
+
<div class="tsd-comment tsd-typography">
|
|
1307
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"npx projen"</span>
|
|
1203
1308
|
</code><button>Copy</button></pre>
|
|
1204
1309
|
</div><aside class="tsd-sources">
|
|
1205
1310
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCommand</p></aside></section>
|
|
1206
1311
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCredentials" class="tsd-anchor"></a>
|
|
1207
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Credentials</span><a href="#projenCredentials" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1312
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Credentials</span><a href="#projenCredentials" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1208
1313
|
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Credentials</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GithubCredentials</span></div>
|
|
1209
1314
|
<div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
1210
|
-
|
|
1211
|
-
<
|
|
1315
|
+
</div>
|
|
1316
|
+
<div class="tsd-comment tsd-typography">
|
|
1317
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">personal</span><span class="hl-1"> </span><span class="hl-4">access</span><span class="hl-1"> </span><span class="hl-4">token</span><span class="hl-1"> </span><span class="hl-4">named</span><span class="hl-1"> </span><span class="hl-6">PROJEN_GITHUB_TOKEN</span>
|
|
1212
1318
|
</code><button>Copy</button></pre>
|
|
1213
1319
|
</div><aside class="tsd-sources">
|
|
1214
1320
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCredentials</p></aside></section>
|
|
1215
1321
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenDevDependency" class="tsd-anchor"></a>
|
|
1216
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Dev<wbr/>Dependency</span><a href="#projenDevDependency" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1322
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Dev<wbr/>Dependency</span><a href="#projenDevDependency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1217
1323
|
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Dev<wbr/>Dependency</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1218
1324
|
<div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
1219
|
-
|
|
1220
|
-
<
|
|
1325
|
+
</div>
|
|
1326
|
+
<div class="tsd-comment tsd-typography">
|
|
1327
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1221
1328
|
</code><button>Copy</button></pre>
|
|
1222
1329
|
</div><aside class="tsd-sources">
|
|
1223
1330
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenDevDependency</p></aside></section>
|
|
1224
1331
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenTokenSecret" class="tsd-anchor"></a>
|
|
1225
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">projen<wbr/>Token<wbr/>Secret</span><a href="#projenTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1332
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">projen<wbr/>Token<wbr/>Secret</span><a href="#projenTokenSecret" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1226
1333
|
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Token<wbr/>Secret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1227
1334
|
<div class="tsd-comment tsd-typography"><p>The name of a secret which includes a GitHub Personal Access Token to be
|
|
1228
1335
|
used by projen workflows. This token needs to have the <code>repo</code>, <code>workflows</code>
|
|
1229
1336
|
and <code>packages</code> scope.</p>
|
|
1230
|
-
|
|
1231
|
-
<
|
|
1337
|
+
</div>
|
|
1338
|
+
<div class="tsd-comment tsd-typography">
|
|
1339
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"PROJEN_GITHUB_TOKEN"</span>
|
|
1232
1340
|
</code><button>Copy</button></pre>
|
|
1233
1341
|
|
|
1234
|
-
<
|
|
1342
|
+
<h4>Deprecated</h4><p>use <code>projenCredentials</code></p>
|
|
1235
1343
|
</div><aside class="tsd-sources">
|
|
1236
1344
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenTokenSecret</p></aside></section>
|
|
1237
1345
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenVersion" class="tsd-anchor"></a>
|
|
1238
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Version</span><a href="#projenVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1346
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projen<wbr/>Version</span><a href="#projenVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1239
1347
|
<div class="tsd-signature"><span class="tsd-kind-property">projen<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1240
1348
|
<div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
1241
|
-
|
|
1242
|
-
<
|
|
1349
|
+
</div>
|
|
1350
|
+
<div class="tsd-comment tsd-typography">
|
|
1351
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">Defaults</span><span class="hl-1"> </span><span class="hl-4">to</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">latest</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1">.</span>
|
|
1243
1352
|
</code><button>Copy</button></pre>
|
|
1244
1353
|
</div><aside class="tsd-sources">
|
|
1245
1354
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenVersion</p></aside></section>
|
|
1246
1355
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJs" class="tsd-anchor"></a>
|
|
1247
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Js</span><a href="#projenrcJs" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1356
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Js</span><a href="#projenrcJs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1248
1357
|
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Js</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1249
1358
|
<div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.js (in JavaScript). Set to <code>false</code> in order to disable
|
|
1250
1359
|
.projenrc.js generation.</p>
|
|
1251
|
-
|
|
1252
|
-
<
|
|
1360
|
+
</div>
|
|
1361
|
+
<div class="tsd-comment tsd-typography">
|
|
1362
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">projenrcJson</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-3">false</span>
|
|
1253
1363
|
</code><button>Copy</button></pre>
|
|
1254
1364
|
</div><aside class="tsd-sources">
|
|
1255
1365
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJs</p></aside></section>
|
|
1256
1366
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsOptions" class="tsd-anchor"></a>
|
|
1257
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Js<wbr/>Options</span><a href="#projenrcJsOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1367
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Js<wbr/>Options</span><a href="#projenrcJsOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1258
1368
|
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Js<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjenrcOptions</span></div>
|
|
1259
1369
|
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.js</p>
|
|
1260
|
-
|
|
1261
|
-
<
|
|
1370
|
+
</div>
|
|
1371
|
+
<div class="tsd-comment tsd-typography">
|
|
1372
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1262
1373
|
</code><button>Copy</button></pre>
|
|
1263
1374
|
</div><aside class="tsd-sources">
|
|
1264
1375
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsOptions</p></aside></section>
|
|
1265
1376
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJson" class="tsd-anchor"></a>
|
|
1266
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Json</span><a href="#projenrcJson" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1377
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Json</span><a href="#projenrcJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1267
1378
|
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Json</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1268
1379
|
<div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.json (in JSON). Set to <code>false</code> in order to disable
|
|
1269
1380
|
.projenrc.json generation.</p>
|
|
1270
|
-
|
|
1271
|
-
<
|
|
1381
|
+
</div>
|
|
1382
|
+
<div class="tsd-comment tsd-typography">
|
|
1383
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1272
1384
|
</code><button>Copy</button></pre>
|
|
1273
1385
|
</div><aside class="tsd-sources">
|
|
1274
1386
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJson</p></aside></section>
|
|
1275
1387
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsonOptions" class="tsd-anchor"></a>
|
|
1276
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Json<wbr/>Options</span><a href="#projenrcJsonOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1388
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Json<wbr/>Options</span><a href="#projenrcJsonOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1277
1389
|
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Json<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjenrcJsonOptions</span></div>
|
|
1278
1390
|
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.json</p>
|
|
1279
|
-
|
|
1280
|
-
<
|
|
1391
|
+
</div>
|
|
1392
|
+
<div class="tsd-comment tsd-typography">
|
|
1393
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1281
1394
|
</code><button>Copy</button></pre>
|
|
1282
1395
|
</div><aside class="tsd-sources">
|
|
1283
1396
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsonOptions</p></aside></section>
|
|
1284
1397
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTs" class="tsd-anchor"></a>
|
|
1285
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Ts</span><a href="#projenrcTs" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1398
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Ts</span><a href="#projenrcTs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1286
1399
|
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Ts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1287
1400
|
<div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
1288
|
-
|
|
1289
|
-
<
|
|
1401
|
+
</div>
|
|
1402
|
+
<div class="tsd-comment tsd-typography">
|
|
1403
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1290
1404
|
</code><button>Copy</button></pre>
|
|
1291
1405
|
|
|
1292
|
-
<
|
|
1406
|
+
<h4>Pjnew</h4><p>true</p>
|
|
1293
1407
|
</div><aside class="tsd-sources">
|
|
1294
1408
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTs</p></aside></section>
|
|
1295
1409
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTsOptions" class="tsd-anchor"></a>
|
|
1296
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrcTsOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1410
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrcTsOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1297
1411
|
<div class="tsd-signature"><span class="tsd-kind-property">projenrc<wbr/>Ts<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ProjenrcOptions</span></div>
|
|
1298
1412
|
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.ts</p>
|
|
1299
|
-
</div
|
|
1413
|
+
</div>
|
|
1414
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1300
1415
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTsOptions</p></aside></section>
|
|
1301
1416
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishDryRun" class="tsd-anchor"></a>
|
|
1302
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>publish<wbr/>Dry<wbr/>Run</span><a href="#publishDryRun" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1417
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>publish<wbr/>Dry<wbr/>Run</span><a href="#publishDryRun" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1303
1418
|
<div class="tsd-signature"><span class="tsd-kind-property">publish<wbr/>Dry<wbr/>Run</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1304
1419
|
<div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
1305
|
-
|
|
1306
|
-
<
|
|
1420
|
+
</div>
|
|
1421
|
+
<div class="tsd-comment tsd-typography">
|
|
1422
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1307
1423
|
</code><button>Copy</button></pre>
|
|
1308
1424
|
</div><aside class="tsd-sources">
|
|
1309
1425
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishDryRun</p></aside></section>
|
|
1310
1426
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishTasks" class="tsd-anchor"></a>
|
|
1311
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>publish<wbr/>Tasks</span><a href="#publishTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1427
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>publish<wbr/>Tasks</span><a href="#publishTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1312
1428
|
<div class="tsd-signature"><span class="tsd-kind-property">publish<wbr/>Tasks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1313
1429
|
<div class="tsd-comment tsd-typography"><p>Define publishing tasks that can be executed manually as well as workflows.</p>
|
|
1314
1430
|
<p>Normally, publishing only happens within automated workflows. Enable this
|
|
1315
1431
|
in order to create a publishing task for each publishing activity.</p>
|
|
1316
|
-
|
|
1317
|
-
<
|
|
1432
|
+
</div>
|
|
1433
|
+
<div class="tsd-comment tsd-typography">
|
|
1434
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1318
1435
|
</code><button>Copy</button></pre>
|
|
1319
1436
|
</div><aside class="tsd-sources">
|
|
1320
1437
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishTasks</p></aside></section>
|
|
1321
1438
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplate" class="tsd-anchor"></a>
|
|
1322
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pull<wbr/>Request<wbr/>Template</span><a href="#pullRequestTemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1439
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pull<wbr/>Request<wbr/>Template</span><a href="#pullRequestTemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1323
1440
|
<div class="tsd-signature"><span class="tsd-kind-property">pull<wbr/>Request<wbr/>Template</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1324
1441
|
<div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
1325
|
-
|
|
1326
|
-
<
|
|
1442
|
+
</div>
|
|
1443
|
+
<div class="tsd-comment tsd-typography">
|
|
1444
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1327
1445
|
</code><button>Copy</button></pre>
|
|
1328
1446
|
</div><aside class="tsd-sources">
|
|
1329
1447
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplate</p></aside></section>
|
|
1330
1448
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplateContents" class="tsd-anchor"></a>
|
|
1331
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><a href="#pullRequestTemplateContents" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1449
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><a href="#pullRequestTemplateContents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1332
1450
|
<div class="tsd-signature"><span class="tsd-kind-property">pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1333
1451
|
<div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
|
|
1334
|
-
|
|
1335
|
-
<
|
|
1452
|
+
</div>
|
|
1453
|
+
<div class="tsd-comment tsd-typography">
|
|
1454
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">content</span>
|
|
1336
1455
|
</code><button>Copy</button></pre>
|
|
1337
1456
|
</div><aside class="tsd-sources">
|
|
1338
1457
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplateContents</p></aside></section>
|
|
1339
1458
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readme" class="tsd-anchor"></a>
|
|
1340
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readme</span><a href="#readme" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1459
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readme</span><a href="#readme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1341
1460
|
<div class="tsd-signature"><span class="tsd-kind-property">readme</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">SampleReadmeProps</span></div>
|
|
1342
1461
|
<div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
1343
|
-
|
|
1344
|
-
<
|
|
1462
|
+
</div>
|
|
1463
|
+
<div class="tsd-comment tsd-typography">
|
|
1464
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- { </span><span class="hl-9">filename</span><span class="hl-1">: </span><span class="hl-2">'README.md'</span><span class="hl-1">, </span><span class="hl-9">contents</span><span class="hl-1">: </span><span class="hl-2">'# replace this'</span><span class="hl-1"> }</span>
|
|
1345
1465
|
</code><button>Copy</button></pre>
|
|
1346
1466
|
|
|
1347
|
-
<
|
|
1467
|
+
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">"{ filename: 'readme.md', contents: '# title' }"</span>
|
|
1348
1468
|
</code><button>Copy</button></pre>
|
|
1349
1469
|
</div><aside class="tsd-sources">
|
|
1350
1470
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.readme</p></aside></section>
|
|
1351
1471
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a>
|
|
1352
|
-
<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
|
|
1472
|
+
<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>
|
|
1353
1473
|
<div class="tsd-signature"><span class="tsd-kind-property">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1354
1474
|
<div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
1355
|
-
|
|
1356
|
-
<
|
|
1475
|
+
</div>
|
|
1476
|
+
<div class="tsd-comment tsd-typography">
|
|
1477
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> (</span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span><span class="hl-1">)</span>
|
|
1357
1478
|
</code><button>Copy</button></pre>
|
|
1358
1479
|
</div><aside class="tsd-sources">
|
|
1359
1480
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.release</p></aside></section>
|
|
1360
1481
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseBranches" class="tsd-anchor"></a>
|
|
1361
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Branches</span><a href="#releaseBranches" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1482
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Branches</span><a href="#releaseBranches" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1362
1483
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Branches</span><span class="tsd-signature-symbol">?:</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 ">BranchOptions</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
1363
1484
|
<div class="tsd-comment tsd-typography"><p>Defines additional release branches. A workflow will be created for each
|
|
1364
1485
|
release branch which will publish releases from commits in this branch.
|
|
@@ -1366,61 +1487,66 @@ Each release branch <em>must</em> be assigned a major version number which is us
|
|
|
1366
1487
|
to enforce that versions published from that branch always use that major
|
|
1367
1488
|
version. If multiple branches are used, the <code>majorVersion</code> field must also
|
|
1368
1489
|
be provided for the default branch.</p>
|
|
1369
|
-
|
|
1370
|
-
<h3>Default</h3><ul>
|
|
1371
|
-
<li>no additional branches are used for release. you can use
|
|
1372
|
-
<code>addBranch()</code> to add additional branches.</li>
|
|
1373
|
-
</ul>
|
|
1374
1490
|
</div>
|
|
1375
1491
|
<div class="tsd-type-declaration">
|
|
1376
1492
|
<h4>Type declaration</h4>
|
|
1377
1493
|
<ul class="tsd-parameters">
|
|
1378
1494
|
<li class="tsd-parameter-index-signature">
|
|
1379
|
-
<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 ">BranchOptions</span></h5></li></ul></div
|
|
1495
|
+
<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 ">BranchOptions</span></h5></li></ul></div>
|
|
1496
|
+
<div class="tsd-comment tsd-typography">
|
|
1497
|
+
<h4>Default</h4><ul>
|
|
1498
|
+
<li>no additional branches are used for release. you can use
|
|
1499
|
+
<code>addBranch()</code> to add additional branches.</li>
|
|
1500
|
+
</ul>
|
|
1501
|
+
</div><aside class="tsd-sources">
|
|
1380
1502
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseBranches</p></aside></section>
|
|
1381
1503
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseEveryCommit" class="tsd-anchor"></a>
|
|
1382
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Every<wbr/>Commit</span><a href="#releaseEveryCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1504
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Every<wbr/>Commit</span><a href="#releaseEveryCommit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1383
1505
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Every<wbr/>Commit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1384
1506
|
<div class="tsd-comment tsd-typography"><p>Automatically release new versions every commit to one of branches in <code>releaseBranches</code>.</p>
|
|
1385
|
-
|
|
1386
|
-
<
|
|
1507
|
+
</div>
|
|
1508
|
+
<div class="tsd-comment tsd-typography">
|
|
1509
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1387
1510
|
</code><button>Copy</button></pre>
|
|
1388
1511
|
|
|
1389
|
-
<
|
|
1512
|
+
<h4>Deprecated</h4><p>Use <code>releaseTrigger: ReleaseTrigger.continuous()</code> instead</p>
|
|
1390
1513
|
</div><aside class="tsd-sources">
|
|
1391
1514
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseEveryCommit</p></aside></section>
|
|
1392
1515
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssue" class="tsd-anchor"></a>
|
|
1393
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Failure<wbr/>Issue</span><a href="#releaseFailureIssue" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1516
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Failure<wbr/>Issue</span><a href="#releaseFailureIssue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1394
1517
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Failure<wbr/>Issue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1395
1518
|
<div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
1396
|
-
|
|
1397
|
-
<
|
|
1519
|
+
</div>
|
|
1520
|
+
<div class="tsd-comment tsd-typography">
|
|
1521
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1398
1522
|
</code><button>Copy</button></pre>
|
|
1399
1523
|
</div><aside class="tsd-sources">
|
|
1400
1524
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssue</p></aside></section>
|
|
1401
1525
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssueLabel" class="tsd-anchor"></a>
|
|
1402
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><a href="#releaseFailureIssueLabel" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1526
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><a href="#releaseFailureIssueLabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1403
1527
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1404
1528
|
<div class="tsd-comment tsd-typography"><p>The label to apply to issues indicating publish failures.
|
|
1405
1529
|
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
1406
|
-
|
|
1407
|
-
<
|
|
1530
|
+
</div>
|
|
1531
|
+
<div class="tsd-comment tsd-typography">
|
|
1532
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"failed-release"</span>
|
|
1408
1533
|
</code><button>Copy</button></pre>
|
|
1409
1534
|
</div><aside class="tsd-sources">
|
|
1410
1535
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssueLabel</p></aside></section>
|
|
1411
1536
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseSchedule" class="tsd-anchor"></a>
|
|
1412
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Schedule</span><a href="#releaseSchedule" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1537
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Schedule</span><a href="#releaseSchedule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1413
1538
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Schedule</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1414
1539
|
<div class="tsd-comment tsd-typography"><p>CRON schedule to trigger new releases.</p>
|
|
1415
|
-
|
|
1416
|
-
<
|
|
1540
|
+
</div>
|
|
1541
|
+
<div class="tsd-comment tsd-typography">
|
|
1542
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">scheduled</span><span class="hl-1"> </span><span class="hl-4">releases</span>
|
|
1417
1543
|
</code><button>Copy</button></pre>
|
|
1418
1544
|
|
|
1419
|
-
<
|
|
1545
|
+
<h4>Deprecated</h4><p>Use <code>releaseTrigger: ReleaseTrigger.scheduled()</code> instead</p>
|
|
1420
1546
|
</div><aside class="tsd-sources">
|
|
1421
1547
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseSchedule</p></aside></section>
|
|
1422
1548
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTagPrefix" class="tsd-anchor"></a>
|
|
1423
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Tag<wbr/>Prefix</span><a href="#releaseTagPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1549
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Tag<wbr/>Prefix</span><a href="#releaseTagPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1424
1550
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Tag<wbr/>Prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1425
1551
|
<div class="tsd-comment tsd-typography"><p>Automatically add the given prefix to release tags.
|
|
1426
1552
|
Useful if you are releasing on multiple branches with overlapping
|
|
@@ -1429,301 +1555,343 @@ version numbers.</p>
|
|
|
1429
1555
|
when bumping, so if you change this on a project with an existing version
|
|
1430
1556
|
history, you may need to manually tag your latest release
|
|
1431
1557
|
with the new prefix.</p>
|
|
1432
|
-
|
|
1433
|
-
<
|
|
1558
|
+
</div>
|
|
1559
|
+
<div class="tsd-comment tsd-typography">
|
|
1560
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"v"</span>
|
|
1434
1561
|
</code><button>Copy</button></pre>
|
|
1435
1562
|
</div><aside class="tsd-sources">
|
|
1436
1563
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTagPrefix</p></aside></section>
|
|
1437
1564
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseToNpm" class="tsd-anchor"></a>
|
|
1438
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>To<wbr/>Npm</span><a href="#releaseToNpm" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1565
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>To<wbr/>Npm</span><a href="#releaseToNpm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1439
1566
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>To<wbr/>Npm</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1440
1567
|
<div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
1441
|
-
|
|
1442
|
-
<
|
|
1568
|
+
</div>
|
|
1569
|
+
<div class="tsd-comment tsd-typography">
|
|
1570
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1443
1571
|
</code><button>Copy</button></pre>
|
|
1444
1572
|
</div><aside class="tsd-sources">
|
|
1445
1573
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseToNpm</p></aside></section>
|
|
1446
1574
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTrigger" class="tsd-anchor"></a>
|
|
1447
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Trigger</span><a href="#releaseTrigger" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1575
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Trigger</span><a href="#releaseTrigger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1448
1576
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Trigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ReleaseTrigger</span></div>
|
|
1449
1577
|
<div class="tsd-comment tsd-typography"><p>The release trigger to use.</p>
|
|
1450
|
-
|
|
1451
|
-
<
|
|
1578
|
+
</div>
|
|
1579
|
+
<div class="tsd-comment tsd-typography">
|
|
1580
|
+
<h4>Default</h4><ul>
|
|
1452
1581
|
<li>Continuous releases (<code>ReleaseTrigger.continuous()</code>)</li>
|
|
1453
1582
|
</ul>
|
|
1454
1583
|
</div><aside class="tsd-sources">
|
|
1455
1584
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTrigger</p></aside></section>
|
|
1456
1585
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflow" class="tsd-anchor"></a>
|
|
1457
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Workflow</span><a href="#releaseWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1586
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">release<wbr/>Workflow</span><a href="#releaseWorkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1458
1587
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Workflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1459
1588
|
<div class="tsd-comment tsd-typography"><p>DEPRECATED: renamed to <code>release</code>.</p>
|
|
1460
|
-
|
|
1461
|
-
<
|
|
1589
|
+
</div>
|
|
1590
|
+
<div class="tsd-comment tsd-typography">
|
|
1591
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
|
|
1462
1592
|
</code><button>Copy</button></pre>
|
|
1463
1593
|
|
|
1464
|
-
<
|
|
1594
|
+
<h4>Deprecated</h4><p>see <code>release</code>.</p>
|
|
1465
1595
|
</div><aside class="tsd-sources">
|
|
1466
1596
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflow</p></aside></section>
|
|
1467
1597
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowName" class="tsd-anchor"></a>
|
|
1468
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Workflow<wbr/>Name</span><a href="#releaseWorkflowName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1598
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Workflow<wbr/>Name</span><a href="#releaseWorkflowName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1469
1599
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Workflow<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1470
1600
|
<div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
1471
|
-
|
|
1472
|
-
<
|
|
1601
|
+
</div>
|
|
1602
|
+
<div class="tsd-comment tsd-typography">
|
|
1603
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"Release"</span>
|
|
1473
1604
|
</code><button>Copy</button></pre>
|
|
1474
1605
|
</div><aside class="tsd-sources">
|
|
1475
1606
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowName</p></aside></section>
|
|
1476
1607
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowSetupSteps" class="tsd-anchor"></a>
|
|
1477
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><a href="#releaseWorkflowSetupSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1608
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><a href="#releaseWorkflowSetupSteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1478
1609
|
<div class="tsd-signature"><span class="tsd-kind-property">release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1479
1610
|
<div class="tsd-comment tsd-typography"><p>A set of workflow steps to execute in order to setup the workflow
|
|
1480
1611
|
container.</p>
|
|
1481
|
-
</div
|
|
1612
|
+
</div>
|
|
1613
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1482
1614
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowSetupSteps</p></aside></section>
|
|
1483
1615
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebot" class="tsd-anchor"></a>
|
|
1484
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>renovatebot</span><a href="#renovatebot" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1616
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>renovatebot</span><a href="#renovatebot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1485
1617
|
<div class="tsd-signature"><span class="tsd-kind-property">renovatebot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1486
1618
|
<div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
1487
|
-
|
|
1488
|
-
<
|
|
1619
|
+
</div>
|
|
1620
|
+
<div class="tsd-comment tsd-typography">
|
|
1621
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1489
1622
|
</code><button>Copy</button></pre>
|
|
1490
1623
|
</div><aside class="tsd-sources">
|
|
1491
1624
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebot</p></aside></section>
|
|
1492
1625
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebotOptions" class="tsd-anchor"></a>
|
|
1493
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>renovatebot<wbr/>Options</span><a href="#renovatebotOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1626
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>renovatebot<wbr/>Options</span><a href="#renovatebotOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1494
1627
|
<div class="tsd-signature"><span class="tsd-kind-property">renovatebot<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">RenovatebotOptions</span></div>
|
|
1495
1628
|
<div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
1496
|
-
|
|
1497
|
-
<
|
|
1629
|
+
</div>
|
|
1630
|
+
<div class="tsd-comment tsd-typography">
|
|
1631
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1498
1632
|
</code><button>Copy</button></pre>
|
|
1499
1633
|
</div><aside class="tsd-sources">
|
|
1500
1634
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebotOptions</p></aside></section>
|
|
1501
1635
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repository" class="tsd-anchor"></a>
|
|
1502
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>repository</span><a href="#repository" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1636
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>repository</span><a href="#repository" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1503
1637
|
<div class="tsd-signature"><span class="tsd-kind-property">repository</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1504
1638
|
<div class="tsd-comment tsd-typography"><p>The repository is the location where the actual code for your package lives.
|
|
1505
1639
|
See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-repository">https://classic.yarnpkg.com/en/docs/package-json/#toc-repository</a></p>
|
|
1506
|
-
</div
|
|
1640
|
+
</div>
|
|
1641
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1507
1642
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repository</p></aside></section>
|
|
1508
1643
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repositoryDirectory" class="tsd-anchor"></a>
|
|
1509
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>repository<wbr/>Directory</span><a href="#repositoryDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1644
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>repository<wbr/>Directory</span><a href="#repositoryDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1510
1645
|
<div class="tsd-signature"><span class="tsd-kind-property">repository<wbr/>Directory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1511
1646
|
<div class="tsd-comment tsd-typography"><p>If the package.json for your package is not in the root directory (for example if it is part of a monorepo),
|
|
1512
1647
|
you can specify the directory in which it lives.</p>
|
|
1513
|
-
</div
|
|
1648
|
+
</div>
|
|
1649
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1514
1650
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repositoryDirectory</p></aside></section>
|
|
1515
1651
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="requireApproval" class="tsd-anchor"></a>
|
|
1516
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>require<wbr/>Approval</span><a href="#requireApproval" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1652
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>require<wbr/>Approval</span><a href="#requireApproval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1517
1653
|
<div class="tsd-signature"><span class="tsd-kind-property">require<wbr/>Approval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ApprovalLevel</span></div>
|
|
1518
1654
|
<div class="tsd-comment tsd-typography"><p>To protect you against unintended changes that affect your security posture,
|
|
1519
1655
|
the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.</p>
|
|
1520
|
-
|
|
1521
|
-
<
|
|
1656
|
+
</div>
|
|
1657
|
+
<div class="tsd-comment tsd-typography">
|
|
1658
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ApprovalLevel</span><span class="hl-1">.</span><span class="hl-6">BROADENING</span>
|
|
1522
1659
|
</code><button>Copy</button></pre>
|
|
1523
1660
|
</div><aside class="tsd-sources">
|
|
1524
1661
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.requireApproval</p></aside></section>
|
|
1525
1662
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sampleCode" class="tsd-anchor"></a>
|
|
1526
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>sample<wbr/>Code</span><a href="#sampleCode" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1663
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>sample<wbr/>Code</span><a href="#sampleCode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1527
1664
|
<div class="tsd-signature"><span class="tsd-kind-property">sample<wbr/>Code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1528
1665
|
<div class="tsd-comment tsd-typography"><p>Generate one-time sample in <code>src/</code> and <code>test/</code> if there are no files there.</p>
|
|
1529
|
-
|
|
1530
|
-
<
|
|
1666
|
+
</div>
|
|
1667
|
+
<div class="tsd-comment tsd-typography">
|
|
1668
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1531
1669
|
</code><button>Copy</button></pre>
|
|
1532
1670
|
</div><aside class="tsd-sources">
|
|
1533
1671
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.sampleCode</p></aside></section>
|
|
1534
1672
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scopedPackagesOptions" class="tsd-anchor"></a>
|
|
1535
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>scoped<wbr/>Packages<wbr/>Options</span><a href="#scopedPackagesOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1673
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>scoped<wbr/>Packages<wbr/>Options</span><a href="#scopedPackagesOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1536
1674
|
<div class="tsd-signature"><span class="tsd-kind-property">scoped<wbr/>Packages<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1537
1675
|
<div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages</p>
|
|
1538
|
-
|
|
1539
|
-
<
|
|
1676
|
+
</div>
|
|
1677
|
+
<div class="tsd-comment tsd-typography">
|
|
1678
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">fetch</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">scoped</span><span class="hl-1"> </span><span class="hl-4">packages</span><span class="hl-1"> </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-4">registry</span>
|
|
1540
1679
|
</code><button>Copy</button></pre>
|
|
1541
1680
|
</div><aside class="tsd-sources">
|
|
1542
1681
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scopedPackagesOptions</p></aside></section>
|
|
1543
1682
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scripts" class="tsd-anchor"></a>
|
|
1544
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">scripts</span><a href="#scripts" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1683
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">scripts</span><a href="#scripts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1545
1684
|
<div class="tsd-signature"><span class="tsd-kind-property">scripts</span><span class="tsd-signature-symbol">?:</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></div>
|
|
1546
1685
|
<div class="tsd-comment tsd-typography"><p>npm scripts to include. If a script has the same name as a standard script,
|
|
1547
1686
|
the standard script will be overwritten.
|
|
1548
1687
|
Also adds the script as a task.</p>
|
|
1549
|
-
|
|
1550
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-0">{}</span>
|
|
1551
|
-
</code><button>Copy</button></pre>
|
|
1552
|
-
|
|
1553
|
-
<h3>Deprecated</h3><p>use <code>project.addTask()</code> or <code>package.setScript()</code></p>
|
|
1554
1688
|
</div>
|
|
1555
1689
|
<div class="tsd-type-declaration">
|
|
1556
1690
|
<h4>Type declaration</h4>
|
|
1557
1691
|
<ul class="tsd-parameters">
|
|
1558
1692
|
<li class="tsd-parameter-index-signature">
|
|
1559
|
-
<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></div
|
|
1693
|
+
<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></div>
|
|
1694
|
+
<div class="tsd-comment tsd-typography">
|
|
1695
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">{}</span>
|
|
1696
|
+
</code><button>Copy</button></pre>
|
|
1697
|
+
|
|
1698
|
+
<h4>Deprecated</h4><p>use <code>project.addTask()</code> or <code>package.setScript()</code></p>
|
|
1699
|
+
</div><aside class="tsd-sources">
|
|
1560
1700
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scripts</p></aside></section>
|
|
1561
1701
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="srcdir" class="tsd-anchor"></a>
|
|
1562
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1702
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1563
1703
|
<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>
|
|
1564
1704
|
<div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
1565
|
-
|
|
1566
|
-
<
|
|
1705
|
+
</div>
|
|
1706
|
+
<div class="tsd-comment tsd-typography">
|
|
1707
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"src"</span>
|
|
1567
1708
|
</code><button>Copy</button></pre>
|
|
1568
1709
|
</div><aside class="tsd-sources">
|
|
1569
1710
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.srcdir</p></aside></section>
|
|
1570
1711
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stability" class="tsd-anchor"></a>
|
|
1571
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stability</span><a href="#stability" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1712
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stability</span><a href="#stability" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1572
1713
|
<div class="tsd-signature"><span class="tsd-kind-property">stability</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1573
1714
|
<div class="tsd-comment tsd-typography"><p>Package's Stability</p>
|
|
1574
|
-
</div
|
|
1715
|
+
</div>
|
|
1716
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1575
1717
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stability</p></aside></section>
|
|
1576
1718
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stale" class="tsd-anchor"></a>
|
|
1577
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stale</span><a href="#stale" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1719
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stale</span><a href="#stale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1578
1720
|
<div class="tsd-signature"><span class="tsd-kind-property">stale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1579
1721
|
<div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request. See <code>staleOptions</code> for options.</p>
|
|
1580
|
-
|
|
1581
|
-
<
|
|
1722
|
+
</div>
|
|
1723
|
+
<div class="tsd-comment tsd-typography">
|
|
1724
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1582
1725
|
</code><button>Copy</button></pre>
|
|
1583
1726
|
</div><aside class="tsd-sources">
|
|
1584
1727
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stale</p></aside></section>
|
|
1585
1728
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="staleOptions" class="tsd-anchor"></a>
|
|
1586
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stale<wbr/>Options</span><a href="#staleOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1729
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stale<wbr/>Options</span><a href="#staleOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1587
1730
|
<div class="tsd-signature"><span class="tsd-kind-property">stale<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">StaleOptions</span></div>
|
|
1588
1731
|
<div class="tsd-comment tsd-typography"><p>Auto-close stale issues and pull requests. To disable set <code>stale</code> to <code>false</code>.</p>
|
|
1589
|
-
|
|
1590
|
-
<
|
|
1732
|
+
</div>
|
|
1733
|
+
<div class="tsd-comment tsd-typography">
|
|
1734
|
+
<h4>Default</h4><ul>
|
|
1591
1735
|
<li>see defaults in <code>StaleOptions</code></li>
|
|
1592
1736
|
</ul>
|
|
1593
1737
|
</div><aside class="tsd-sources">
|
|
1594
1738
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.staleOptions</p></aside></section>
|
|
1595
1739
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testdir" class="tsd-anchor"></a>
|
|
1596
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>testdir</span><a href="#testdir" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1740
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1597
1741
|
<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>
|
|
1598
1742
|
<div class="tsd-comment tsd-typography"><p>Jest tests directory. Tests files should be named <code>xxx.test.ts</code>.</p>
|
|
1599
1743
|
<p>If this directory is under <code>srcdir</code> (e.g. <code>src/test</code>, <code>src/__tests__</code>),
|
|
1600
1744
|
then tests are going to be compiled into <code>lib/</code> and executed as javascript.
|
|
1601
1745
|
If the test directory is outside of <code>src</code>, then we configure jest to
|
|
1602
1746
|
compile the code in-memory.</p>
|
|
1603
|
-
|
|
1604
|
-
<
|
|
1747
|
+
</div>
|
|
1748
|
+
<div class="tsd-comment tsd-typography">
|
|
1749
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"test"</span>
|
|
1605
1750
|
</code><button>Copy</button></pre>
|
|
1606
1751
|
</div><aside class="tsd-sources">
|
|
1607
1752
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.testdir</p></aside></section>
|
|
1608
1753
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a>
|
|
1609
|
-
<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
|
|
1754
|
+
<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>
|
|
1610
1755
|
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TypescriptConfigOptions</span></div>
|
|
1611
1756
|
<div class="tsd-comment tsd-typography"><p>Custom TSConfig</p>
|
|
1612
|
-
|
|
1613
|
-
<
|
|
1757
|
+
</div>
|
|
1758
|
+
<div class="tsd-comment tsd-typography">
|
|
1759
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1614
1760
|
</code><button>Copy</button></pre>
|
|
1615
1761
|
</div><aside class="tsd-sources">
|
|
1616
1762
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfig</p></aside></section>
|
|
1617
1763
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDev" class="tsd-anchor"></a>
|
|
1618
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev</span><a href="#tsconfigDev" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1764
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1619
1765
|
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Dev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TypescriptConfigOptions</span></div>
|
|
1620
1766
|
<div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
1621
|
-
|
|
1622
|
-
<
|
|
1767
|
+
</div>
|
|
1768
|
+
<div class="tsd-comment tsd-typography">
|
|
1769
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">production</span><span class="hl-1"> </span><span class="hl-4">tsconfig</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1623
1770
|
</code><button>Copy</button></pre>
|
|
1624
1771
|
</div><aside class="tsd-sources">
|
|
1625
1772
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDev</p></aside></section>
|
|
1626
1773
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDevFile" class="tsd-anchor"></a>
|
|
1627
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev<wbr/>File</span><a href="#tsconfigDevFile" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1774
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tsconfig<wbr/>Dev<wbr/>File</span><a href="#tsconfigDevFile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1628
1775
|
<div class="tsd-signature"><span class="tsd-kind-property">tsconfig<wbr/>Dev<wbr/>File</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1629
1776
|
<div class="tsd-comment tsd-typography"><p>The name of the development tsconfig.json file.</p>
|
|
1630
|
-
|
|
1631
|
-
<
|
|
1777
|
+
</div>
|
|
1778
|
+
<div class="tsd-comment tsd-typography">
|
|
1779
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"tsconfig.dev.json"</span>
|
|
1632
1780
|
</code><button>Copy</button></pre>
|
|
1633
1781
|
</div><aside class="tsd-sources">
|
|
1634
1782
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDevFile</p></aside></section>
|
|
1635
1783
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="typescriptVersion" class="tsd-anchor"></a>
|
|
1636
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>typescript<wbr/>Version</span><a href="#typescriptVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1784
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>typescript<wbr/>Version</span><a href="#typescriptVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1637
1785
|
<div class="tsd-signature"><span class="tsd-kind-property">typescript<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1638
1786
|
<div class="tsd-comment tsd-typography"><p>TypeScript version to use.</p>
|
|
1639
1787
|
<p>NOTE: Typescript is not semantically versioned and should remain on the
|
|
1640
1788
|
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
1641
|
-
|
|
1642
|
-
<
|
|
1789
|
+
</div>
|
|
1790
|
+
<div class="tsd-comment tsd-typography">
|
|
1791
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"latest"</span>
|
|
1643
1792
|
</code><button>Copy</button></pre>
|
|
1644
1793
|
</div><aside class="tsd-sources">
|
|
1645
1794
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.typescriptVersion</p></aside></section>
|
|
1646
1795
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="versionrcOptions" class="tsd-anchor"></a>
|
|
1647
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>versionrc<wbr/>Options</span><a href="#versionrcOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1796
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>versionrc<wbr/>Options</span><a href="#versionrcOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1648
1797
|
<div class="tsd-signature"><span class="tsd-kind-property">versionrc<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
1649
1798
|
<div class="tsd-comment tsd-typography"><p>Custom configuration used when creating changelog with standard-version package.
|
|
1650
1799
|
Given values either append to default configuration or overwrite values in it.</p>
|
|
1651
|
-
|
|
1652
|
-
<
|
|
1800
|
+
</div>
|
|
1801
|
+
<div class="tsd-comment tsd-typography">
|
|
1802
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">standard</span><span class="hl-1"> </span><span class="hl-4">configuration</span><span class="hl-1"> </span><span class="hl-4">applicable</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">GitHub</span><span class="hl-1"> </span><span class="hl-4">repositories</span>
|
|
1653
1803
|
</code><button>Copy</button></pre>
|
|
1654
1804
|
</div><aside class="tsd-sources">
|
|
1655
1805
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.versionrcOptions</p></aside></section>
|
|
1656
1806
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a>
|
|
1657
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1807
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
|
|
1658
1808
|
<div class="tsd-signature"><span class="tsd-kind-property">vscode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1659
1809
|
<div class="tsd-comment tsd-typography"><p>Enable VSCode integration.</p>
|
|
1660
1810
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
1661
|
-
|
|
1662
|
-
<
|
|
1811
|
+
</div>
|
|
1812
|
+
<div class="tsd-comment tsd-typography">
|
|
1813
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1663
1814
|
</code><button>Copy</button></pre>
|
|
1664
1815
|
</div><aside class="tsd-sources">
|
|
1665
1816
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.vscode</p></aside></section>
|
|
1666
1817
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchExcludes" class="tsd-anchor"></a>
|
|
1667
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Excludes</span><a href="#watchExcludes" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1818
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Excludes</span><a href="#watchExcludes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1668
1819
|
<div class="tsd-signature"><span class="tsd-kind-property">watch<wbr/>Excludes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1669
1820
|
<div class="tsd-comment tsd-typography"><p>Glob patterns to exclude from <code>cdk watch</code>.</p>
|
|
1670
|
-
|
|
1671
|
-
<
|
|
1821
|
+
</div>
|
|
1822
|
+
<div class="tsd-comment tsd-typography">
|
|
1823
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
1672
1824
|
</code><button>Copy</button></pre>
|
|
1673
1825
|
</div><aside class="tsd-sources">
|
|
1674
1826
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchExcludes</p></aside></section>
|
|
1675
1827
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchIncludes" class="tsd-anchor"></a>
|
|
1676
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Includes</span><a href="#watchIncludes" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1828
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>watch<wbr/>Includes</span><a href="#watchIncludes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1677
1829
|
<div class="tsd-signature"><span class="tsd-kind-property">watch<wbr/>Includes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1678
1830
|
<div class="tsd-comment tsd-typography"><p>Glob patterns to include in <code>cdk watch</code>.</p>
|
|
1679
|
-
|
|
1680
|
-
<
|
|
1831
|
+
</div>
|
|
1832
|
+
<div class="tsd-comment tsd-typography">
|
|
1833
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
1681
1834
|
</code><button>Copy</button></pre>
|
|
1682
1835
|
</div><aside class="tsd-sources">
|
|
1683
1836
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchIncludes</p></aside></section>
|
|
1684
1837
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowBootstrapSteps" class="tsd-anchor"></a>
|
|
1685
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</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
|
|
1838
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</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>
|
|
1686
1839
|
<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>
|
|
1687
1840
|
<div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
1688
|
-
|
|
1689
|
-
<
|
|
1841
|
+
</div>
|
|
1842
|
+
<div class="tsd-comment tsd-typography">
|
|
1843
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
1690
1844
|
</code><button>Copy</button></pre>
|
|
1691
1845
|
</div><aside class="tsd-sources">
|
|
1692
1846
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowBootstrapSteps</p></aside></section>
|
|
1693
1847
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowContainerImage" class="tsd-anchor"></a>
|
|
1694
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Container<wbr/>Image</span><a href="#workflowContainerImage" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1848
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Container<wbr/>Image</span><a href="#workflowContainerImage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1695
1849
|
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Container<wbr/>Image</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1696
1850
|
<div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
1697
|
-
|
|
1698
|
-
<
|
|
1851
|
+
</div>
|
|
1852
|
+
<div class="tsd-comment tsd-typography">
|
|
1853
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">image</span>
|
|
1699
1854
|
</code><button>Copy</button></pre>
|
|
1700
1855
|
</div><aside class="tsd-sources">
|
|
1701
1856
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowContainerImage</p></aside></section>
|
|
1702
1857
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowGitIdentity" class="tsd-anchor"></a>
|
|
1703
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Git<wbr/>Identity</span><a href="#workflowGitIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1858
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Git<wbr/>Identity</span><a href="#workflowGitIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1704
1859
|
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Git<wbr/>Identity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GitIdentity</span></div>
|
|
1705
1860
|
<div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
1706
|
-
|
|
1707
|
-
<
|
|
1861
|
+
</div>
|
|
1862
|
+
<div class="tsd-comment tsd-typography">
|
|
1863
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">GitHub</span><span class="hl-1"> </span><span class="hl-4">Actions</span>
|
|
1708
1864
|
</code><button>Copy</button></pre>
|
|
1709
1865
|
</div><aside class="tsd-sources">
|
|
1710
1866
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowGitIdentity</p></aside></section>
|
|
1711
1867
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowNodeVersion" class="tsd-anchor"></a>
|
|
1712
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Node<wbr/>Version</span><a href="#workflowNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1868
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Node<wbr/>Version</span><a href="#workflowNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1713
1869
|
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1714
1870
|
<div class="tsd-comment tsd-typography"><p>The node version to use in GitHub workflows.</p>
|
|
1715
|
-
|
|
1716
|
-
<
|
|
1871
|
+
</div>
|
|
1872
|
+
<div class="tsd-comment tsd-typography">
|
|
1873
|
+
<h4>Default</h4><ul>
|
|
1717
1874
|
<li>same as <code>minNodeVersion</code></li>
|
|
1718
1875
|
</ul>
|
|
1719
1876
|
</div><aside class="tsd-sources">
|
|
1720
1877
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowNodeVersion</p></aside></section>
|
|
1878
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowPackageCache" class="tsd-anchor"></a>
|
|
1879
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</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>
|
|
1880
|
+
<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>
|
|
1881
|
+
<div class="tsd-comment tsd-typography"><p>Enable Node.js package cache in GitHub workflows.</p>
|
|
1882
|
+
</div>
|
|
1883
|
+
<div class="tsd-comment tsd-typography">
|
|
1884
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1885
|
+
</code><button>Copy</button></pre>
|
|
1886
|
+
</div><aside class="tsd-sources">
|
|
1887
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowPackageCache</p></aside></section>
|
|
1721
1888
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowRunsOn" class="tsd-anchor"></a>
|
|
1722
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Runs<wbr/>On</span><a href="#workflowRunsOn" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1889
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Runs<wbr/>On</span><a href="#workflowRunsOn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1723
1890
|
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Runs<wbr/>On</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1724
1891
|
<div class="tsd-comment tsd-typography"><p>Github Runner selection labels</p>
|
|
1725
|
-
|
|
1726
|
-
<
|
|
1892
|
+
</div>
|
|
1893
|
+
<div class="tsd-comment tsd-typography">
|
|
1894
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[</span><span class="hl-2">"ubuntu-latest"</span><span class="hl-1">]</span>
|
|
1727
1895
|
</code><button>Copy</button></pre>
|
|
1728
1896
|
</div><aside class="tsd-sources">
|
|
1729
1897
|
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowRunsOn</p></aside></section></section></div>
|
|
@@ -1731,7 +1899,7 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1731
1899
|
<div class="page-menu">
|
|
1732
1900
|
<div class="tsd-navigation settings">
|
|
1733
1901
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1734
|
-
<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>
|
|
1902
|
+
<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>
|
|
1735
1903
|
<div class="tsd-accordion-details">
|
|
1736
1904
|
<div class="tsd-filter-visibility">
|
|
1737
1905
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -1743,179 +1911,182 @@ Given values either append to default configuration or overwrite values in it.</
|
|
|
1743
1911
|
<div class="tsd-theme-toggle">
|
|
1744
1912
|
<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>
|
|
1745
1913
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1746
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
1914
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1747
1915
|
<div class="tsd-accordion-details">
|
|
1748
1916
|
<ul>
|
|
1749
|
-
<li><a href="#allowLibraryDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1750
|
-
<li><a href="#appEntrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1751
|
-
<li><a href="#artifactsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1752
|
-
<li><a href="#authorEmail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1753
|
-
<li><a href="#authorName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1754
|
-
<li><a href="#authorOrganization" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1755
|
-
<li><a href="#authorUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1756
|
-
<li><a href="#autoApproveOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1757
|
-
<li><a href="#autoApproveUpgrades" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1758
|
-
<li><a href="#autoDetectBin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1759
|
-
<li><a href="#autoMerge" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1760
|
-
<li><a href="#autoMergeOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1761
|
-
<li><a href="#bin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1762
|
-
<li><a href="#bugsEmail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1763
|
-
<li><a href="#bugsUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1764
|
-
<li><a href="#buildCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1765
|
-
<li><a href="#buildWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1766
|
-
<li><a href="#buildWorkflowTriggers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1767
|
-
<li><a href="#bundledDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1768
|
-
<li><a href="#bundlerOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1769
|
-
<li><a href="#cdkAssert" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1770
|
-
<li><a href="#cdkAssertions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1771
|
-
<li><a href="#cdkDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1772
|
-
<li><a href="#cdkDependenciesAsDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1773
|
-
<li><a href="#cdkTestDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1774
|
-
<li><a href="#cdkVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1775
|
-
<li><a href="#cdkVersionPinning" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1776
|
-
<li><a href="#cdkout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1777
|
-
<li><a href="#clobber" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1778
|
-
<li><a href="#codeArtifactOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1779
|
-
<li><a href="#codeCov" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1780
|
-
<li><a href="#codeCovTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1781
|
-
<li><a href="#commitGenerated" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1782
|
-
<li><a href="#constructsVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1783
|
-
<li><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1784
|
-
<li><a href="#copyrightOwner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1785
|
-
<li><a href="#copyrightPeriod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1786
|
-
<li><a href="#defaultReleaseBranch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1787
|
-
<li><a href="#dependabot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1788
|
-
<li><a href="#dependabotOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1789
|
-
<li><a href="#deps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1790
|
-
<li><a href="#depsUpgrade" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1791
|
-
<li><a href="#depsUpgradeOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1792
|
-
<li><a href="#description" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1793
|
-
<li><a href="#devContainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1794
|
-
<li><a href="#devDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1795
|
-
<li><a href="#disableTsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1796
|
-
<li><a href="#disableTsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1797
|
-
<li><a href="#docgen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1798
|
-
<li><a href="#docsDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1799
|
-
<li><a href="#edgeLambdaAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1800
|
-
<li><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1801
|
-
<li><a href="#entrypointTypes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1802
|
-
<li><a href="#eslint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1803
|
-
<li><a href="#eslintOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1804
|
-
<li><a href="#featureFlags" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1805
|
-
<li><a href="#gitIgnoreOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1806
|
-
<li><a href="#gitOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1807
|
-
<li><a href="#github" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1808
|
-
<li><a href="#githubOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1809
|
-
<li><a href="#gitignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1810
|
-
<li><a href="#gitpod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1811
|
-
<li><a href="#homepage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1812
|
-
<li><a href="#integrationTestAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1813
|
-
<li><a href="#jest" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1814
|
-
<li><a href="#jestOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1815
|
-
<li><a href="#jsiiReleaseVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1816
|
-
<li><a href="#keywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1817
|
-
<li><a href="#lambdaAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1818
|
-
<li><a href="#lambdaExtensionAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1819
|
-
<li><a href="#lambdaOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1820
|
-
<li><a href="#libdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1821
|
-
<li><a href="#license" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1822
|
-
<li><a href="#licensed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1823
|
-
<li><a href="#logging" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1824
|
-
<li><a href="#majorVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1825
|
-
<li><a href="#maxNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1826
|
-
<li><a href="#mergify" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1827
|
-
<li><a href="#mergifyOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1828
|
-
<li><a href="#minMajorVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1829
|
-
<li><a href="#minNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1830
|
-
<li><a href="#mutableBuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1831
|
-
<li><a href="#name" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1832
|
-
<li><a href="#npmAccess" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1833
|
-
<li><a href="#npmDistTag" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1834
|
-
<li><a href="#npmIgnoreOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1835
|
-
<li><a href="#npmRegistry" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1836
|
-
<li><a href="#npmRegistryUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1837
|
-
<li><a href="#npmTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1838
|
-
<li><a href="#npmignore" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1839
|
-
<li><a href="#npmignoreEnabled" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1840
|
-
<li><a href="#outdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1841
|
-
<li><a href="#package" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1842
|
-
<li><a href="#packageManager" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1843
|
-
<li><a href="#packageName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1844
|
-
<li><a href="#parent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1845
|
-
<li><a href="#peerDependencyOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1846
|
-
<li><a href="#peerDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1847
|
-
<li><a href="#pnpmVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1848
|
-
<li><a href="#postBuildSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1849
|
-
<li><a href="#prerelease" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1850
|
-
<li><a href="#prettier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1851
|
-
<li><a href="#prettierOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1852
|
-
<li><a href="#projectType" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1853
|
-
<li><a href="#projenCommand" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1854
|
-
<li><a href="#projenCredentials" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1855
|
-
<li><a href="#projenDevDependency" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1856
|
-
<li><a href="#projenTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1857
|
-
<li><a href="#projenVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1858
|
-
<li><a href="#projenrcJs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1859
|
-
<li><a href="#projenrcJsOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1860
|
-
<li><a href="#projenrcJson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1861
|
-
<li><a href="#projenrcJsonOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1862
|
-
<li><a href="#projenrcTs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1863
|
-
<li><a href="#projenrcTsOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1864
|
-
<li><a href="#publishDryRun" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1865
|
-
<li><a href="#publishTasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1866
|
-
<li><a href="#pullRequestTemplate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1867
|
-
<li><a href="#pullRequestTemplateContents" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1868
|
-
<li><a href="#readme" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1869
|
-
<li><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1870
|
-
<li><a href="#releaseBranches" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1871
|
-
<li><a href="#releaseEveryCommit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1872
|
-
<li><a href="#releaseFailureIssue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1873
|
-
<li><a href="#releaseFailureIssueLabel" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1874
|
-
<li><a href="#releaseSchedule" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1875
|
-
<li><a href="#releaseTagPrefix" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1876
|
-
<li><a href="#releaseToNpm" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1877
|
-
<li><a href="#releaseTrigger" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1878
|
-
<li><a href="#releaseWorkflow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1879
|
-
<li><a href="#releaseWorkflowName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1880
|
-
<li><a href="#releaseWorkflowSetupSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1881
|
-
<li><a href="#renovatebot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1882
|
-
<li><a href="#renovatebotOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1883
|
-
<li><a href="#repository" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1884
|
-
<li><a href="#repositoryDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1885
|
-
<li><a href="#requireApproval" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1886
|
-
<li><a href="#sampleCode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1887
|
-
<li><a href="#scopedPackagesOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1888
|
-
<li><a href="#scripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1889
|
-
<li><a href="#srcdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1890
|
-
<li><a href="#stability" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1891
|
-
<li><a href="#stale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1892
|
-
<li><a href="#staleOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1893
|
-
<li><a href="#testdir" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1894
|
-
<li><a href="#tsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1895
|
-
<li><a href="#tsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1896
|
-
<li><a href="#tsconfigDevFile" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1897
|
-
<li><a href="#typescriptVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1898
|
-
<li><a href="#versionrcOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1899
|
-
<li><a href="#vscode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1900
|
-
<li><a href="#watchExcludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1901
|
-
<li><a href="#watchIncludes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1902
|
-
<li><a href="#workflowBootstrapSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1903
|
-
<li><a href="#workflowContainerImage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1904
|
-
<li><a href="#workflowGitIdentity" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1905
|
-
<li><a href="#workflowNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1906
|
-
<li><a href="#
|
|
1917
|
+
<li><a href="#allowLibraryDependencies" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a></li>
|
|
1918
|
+
<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>
|
|
1919
|
+
<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>
|
|
1920
|
+
<li><a href="#authorEmail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>author<wbr/>Email</span></a></li>
|
|
1921
|
+
<li><a href="#authorName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>author<wbr/>Name</span></a></li>
|
|
1922
|
+
<li><a href="#authorOrganization" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>author<wbr/>Organization</span></a></li>
|
|
1923
|
+
<li><a href="#authorUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>author<wbr/>Url</span></a></li>
|
|
1924
|
+
<li><a href="#autoApproveOptions" 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<wbr/>Options</span></a></li>
|
|
1925
|
+
<li><a href="#autoApproveUpgrades" 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<wbr/>Upgrades</span></a></li>
|
|
1926
|
+
<li><a href="#autoDetectBin" 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/>Detect<wbr/>Bin</span></a></li>
|
|
1927
|
+
<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>
|
|
1928
|
+
<li><a href="#autoMergeOptions" 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<wbr/>Options</span></a></li>
|
|
1929
|
+
<li><a href="#bin" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bin</span></a></li>
|
|
1930
|
+
<li><a href="#bugsEmail" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bugs<wbr/>Email</span></a></li>
|
|
1931
|
+
<li><a href="#bugsUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bugs<wbr/>Url</span></a></li>
|
|
1932
|
+
<li><a href="#buildCommand" 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/>Command</span></a></li>
|
|
1933
|
+
<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>
|
|
1934
|
+
<li><a href="#buildWorkflowTriggers" 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<wbr/>Triggers</span></a></li>
|
|
1935
|
+
<li><a href="#bundledDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>bundled<wbr/>Deps</span></a></li>
|
|
1936
|
+
<li><a href="#bundlerOptions" 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<wbr/>Options</span></a></li>
|
|
1937
|
+
<li><a href="#cdkAssert" 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/>Assert</span></a></li>
|
|
1938
|
+
<li><a href="#cdkAssertions" 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/>Assertions</span></a></li>
|
|
1939
|
+
<li><a href="#cdkDependencies" 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/>Dependencies</span></a></li>
|
|
1940
|
+
<li><a href="#cdkDependenciesAsDeps" 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/>Dependencies<wbr/>As<wbr/>Deps</span></a></li>
|
|
1941
|
+
<li><a href="#cdkTestDependencies" 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/>Test<wbr/>Dependencies</span></a></li>
|
|
1942
|
+
<li><a href="#cdkVersion" 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/>Version</span></a></li>
|
|
1943
|
+
<li><a href="#cdkVersionPinning" 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/>Version<wbr/>Pinning</span></a></li>
|
|
1944
|
+
<li><a href="#cdkout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cdkout</span></a></li>
|
|
1945
|
+
<li><a href="#clobber" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>clobber</span></a></li>
|
|
1946
|
+
<li><a href="#codeArtifactOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>code<wbr/>Artifact<wbr/>Options</span></a></li>
|
|
1947
|
+
<li><a href="#codeCov" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>code<wbr/>Cov</span></a></li>
|
|
1948
|
+
<li><a href="#codeCovTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span></a></li>
|
|
1949
|
+
<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>
|
|
1950
|
+
<li><a href="#constructsVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>constructs<wbr/>Version</span></a></li>
|
|
1951
|
+
<li><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>context</span></a></li>
|
|
1952
|
+
<li><a href="#copyrightOwner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>copyright<wbr/>Owner</span></a></li>
|
|
1953
|
+
<li><a href="#copyrightPeriod" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>copyright<wbr/>Period</span></a></li>
|
|
1954
|
+
<li><a href="#defaultReleaseBranch" 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/>Release<wbr/>Branch</span></a></li>
|
|
1955
|
+
<li><a href="#dependabot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dependabot</span></a></li>
|
|
1956
|
+
<li><a href="#dependabotOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dependabot<wbr/>Options</span></a></li>
|
|
1957
|
+
<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>
|
|
1958
|
+
<li><a href="#depsUpgrade" 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<wbr/>Upgrade</span></a></li>
|
|
1959
|
+
<li><a href="#depsUpgradeOptions" 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<wbr/>Upgrade<wbr/>Options</span></a></li>
|
|
1960
|
+
<li><a href="#description" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>description</span></a></li>
|
|
1961
|
+
<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>
|
|
1962
|
+
<li><a href="#devDeps" 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/>Deps</span></a></li>
|
|
1963
|
+
<li><a href="#disableTsconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>disable<wbr/>Tsconfig</span></a></li>
|
|
1964
|
+
<li><a href="#disableTsconfigDev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev</span></a></li>
|
|
1965
|
+
<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>
|
|
1966
|
+
<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>
|
|
1967
|
+
<li><a href="#edgeLambdaAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>edge<wbr/>Lambda<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1968
|
+
<li><a href="#entrypoint" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>entrypoint</span></a></li>
|
|
1969
|
+
<li><a href="#entrypointTypes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>entrypoint<wbr/>Types</span></a></li>
|
|
1970
|
+
<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>
|
|
1971
|
+
<li><a href="#eslintOptions" 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<wbr/>Options</span></a></li>
|
|
1972
|
+
<li><a href="#featureFlags" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>feature<wbr/>Flags</span></a></li>
|
|
1973
|
+
<li><a href="#gitIgnoreOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>git<wbr/>Ignore<wbr/>Options</span></a></li>
|
|
1974
|
+
<li><a href="#gitOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>git<wbr/>Options</span></a></li>
|
|
1975
|
+
<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>
|
|
1976
|
+
<li><a href="#githubOptions" 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<wbr/>Options</span></a></li>
|
|
1977
|
+
<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>
|
|
1978
|
+
<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>
|
|
1979
|
+
<li><a href="#homepage" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>homepage</span></a></li>
|
|
1980
|
+
<li><a href="#integrationTestAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>integration<wbr/>Test<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1981
|
+
<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>
|
|
1982
|
+
<li><a href="#jestOptions" 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<wbr/>Options</span></a></li>
|
|
1983
|
+
<li><a href="#jsiiReleaseVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>jsii<wbr/>Release<wbr/>Version</span></a></li>
|
|
1984
|
+
<li><a href="#keywords" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keywords</span></a></li>
|
|
1985
|
+
<li><a href="#lambdaAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1986
|
+
<li><a href="#lambdaExtensionAutoDiscover" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Extension<wbr/>Auto<wbr/>Discover</span></a></li>
|
|
1987
|
+
<li><a href="#lambdaOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a></li>
|
|
1988
|
+
<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>
|
|
1989
|
+
<li><a href="#license" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>license</span></a></li>
|
|
1990
|
+
<li><a href="#licensed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>licensed</span></a></li>
|
|
1991
|
+
<li><a href="#logging" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>logging</span></a></li>
|
|
1992
|
+
<li><a href="#majorVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>major<wbr/>Version</span></a></li>
|
|
1993
|
+
<li><a href="#maxNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a></li>
|
|
1994
|
+
<li><a href="#mergify" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>mergify</span></a></li>
|
|
1995
|
+
<li><a href="#mergifyOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>mergify<wbr/>Options</span></a></li>
|
|
1996
|
+
<li><a href="#minMajorVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>min<wbr/>Major<wbr/>Version</span></a></li>
|
|
1997
|
+
<li><a href="#minNodeVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a></li>
|
|
1998
|
+
<li><a href="#mutableBuild" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>mutable<wbr/>Build</span></a></li>
|
|
1999
|
+
<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>
|
|
2000
|
+
<li><a href="#npmAccess" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npm<wbr/>Access</span></a></li>
|
|
2001
|
+
<li><a href="#npmDistTag" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npm<wbr/>Dist<wbr/>Tag</span></a></li>
|
|
2002
|
+
<li><a href="#npmIgnoreOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npm<wbr/>Ignore<wbr/>Options</span></a></li>
|
|
2003
|
+
<li><a href="#npmRegistry" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npm<wbr/>Registry</span></a></li>
|
|
2004
|
+
<li><a href="#npmRegistryUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npm<wbr/>Registry<wbr/>Url</span></a></li>
|
|
2005
|
+
<li><a href="#npmTokenSecret" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>npm<wbr/>Token<wbr/>Secret</span></a></li>
|
|
2006
|
+
<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>
|
|
2007
|
+
<li><a href="#npmignoreEnabled" 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<wbr/>Enabled</span></a></li>
|
|
2008
|
+
<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>
|
|
2009
|
+
<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>
|
|
2010
|
+
<li><a href="#packageManager" 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<wbr/>Manager</span></a></li>
|
|
2011
|
+
<li><a href="#packageName" 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<wbr/>Name</span></a></li>
|
|
2012
|
+
<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>
|
|
2013
|
+
<li><a href="#peerDependencyOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>peer<wbr/>Dependency<wbr/>Options</span></a></li>
|
|
2014
|
+
<li><a href="#peerDeps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>peer<wbr/>Deps</span></a></li>
|
|
2015
|
+
<li><a href="#pnpmVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pnpm<wbr/>Version</span></a></li>
|
|
2016
|
+
<li><a href="#postBuildSteps" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>post<wbr/>Build<wbr/>Steps</span></a></li>
|
|
2017
|
+
<li><a href="#prerelease" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prerelease</span></a></li>
|
|
2018
|
+
<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>
|
|
2019
|
+
<li><a href="#prettierOptions" 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<wbr/>Options</span></a></li>
|
|
2020
|
+
<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>
|
|
2021
|
+
<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>
|
|
2022
|
+
<li><a href="#projenCredentials" 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/>Credentials</span></a></li>
|
|
2023
|
+
<li><a href="#projenDevDependency" 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/>Dev<wbr/>Dependency</span></a></li>
|
|
2024
|
+
<li><a href="#projenTokenSecret" 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/>Token<wbr/>Secret</span></a></li>
|
|
2025
|
+
<li><a href="#projenVersion" 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/>Version</span></a></li>
|
|
2026
|
+
<li><a href="#projenrcJs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projenrc<wbr/>Js</span></a></li>
|
|
2027
|
+
<li><a href="#projenrcJsOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projenrc<wbr/>Js<wbr/>Options</span></a></li>
|
|
2028
|
+
<li><a href="#projenrcJson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projenrc<wbr/>Json</span></a></li>
|
|
2029
|
+
<li><a href="#projenrcJsonOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projenrc<wbr/>Json<wbr/>Options</span></a></li>
|
|
2030
|
+
<li><a href="#projenrcTs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projenrc<wbr/>Ts</span></a></li>
|
|
2031
|
+
<li><a href="#projenrcTsOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options</span></a></li>
|
|
2032
|
+
<li><a href="#publishDryRun" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>publish<wbr/>Dry<wbr/>Run</span></a></li>
|
|
2033
|
+
<li><a href="#publishTasks" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>publish<wbr/>Tasks</span></a></li>
|
|
2034
|
+
<li><a href="#pullRequestTemplate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a></li>
|
|
2035
|
+
<li><a href="#pullRequestTemplateContents" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a></li>
|
|
2036
|
+
<li><a href="#readme" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readme</span></a></li>
|
|
2037
|
+
<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>
|
|
2038
|
+
<li><a href="#releaseBranches" 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<wbr/>Branches</span></a></li>
|
|
2039
|
+
<li><a href="#releaseEveryCommit" 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<wbr/>Every<wbr/>Commit</span></a></li>
|
|
2040
|
+
<li><a href="#releaseFailureIssue" 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<wbr/>Failure<wbr/>Issue</span></a></li>
|
|
2041
|
+
<li><a href="#releaseFailureIssueLabel" 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<wbr/>Failure<wbr/>Issue<wbr/>Label</span></a></li>
|
|
2042
|
+
<li><a href="#releaseSchedule" 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<wbr/>Schedule</span></a></li>
|
|
2043
|
+
<li><a href="#releaseTagPrefix" 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<wbr/>Tag<wbr/>Prefix</span></a></li>
|
|
2044
|
+
<li><a href="#releaseToNpm" 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<wbr/>To<wbr/>Npm</span></a></li>
|
|
2045
|
+
<li><a href="#releaseTrigger" 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<wbr/>Trigger</span></a></li>
|
|
2046
|
+
<li><a href="#releaseWorkflow" 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<wbr/>Workflow</span></a></li>
|
|
2047
|
+
<li><a href="#releaseWorkflowName" 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<wbr/>Workflow<wbr/>Name</span></a></li>
|
|
2048
|
+
<li><a href="#releaseWorkflowSetupSteps" 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<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span></a></li>
|
|
2049
|
+
<li><a href="#renovatebot" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>renovatebot</span></a></li>
|
|
2050
|
+
<li><a href="#renovatebotOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>renovatebot<wbr/>Options</span></a></li>
|
|
2051
|
+
<li><a href="#repository" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>repository</span></a></li>
|
|
2052
|
+
<li><a href="#repositoryDirectory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>repository<wbr/>Directory</span></a></li>
|
|
2053
|
+
<li><a href="#requireApproval" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>require<wbr/>Approval</span></a></li>
|
|
2054
|
+
<li><a href="#sampleCode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>sample<wbr/>Code</span></a></li>
|
|
2055
|
+
<li><a href="#scopedPackagesOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>scoped<wbr/>Packages<wbr/>Options</span></a></li>
|
|
2056
|
+
<li><a href="#scripts" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>scripts</span></a></li>
|
|
2057
|
+
<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>
|
|
2058
|
+
<li><a href="#stability" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stability</span></a></li>
|
|
2059
|
+
<li><a href="#stale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stale</span></a></li>
|
|
2060
|
+
<li><a href="#staleOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stale<wbr/>Options</span></a></li>
|
|
2061
|
+
<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>
|
|
2062
|
+
<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>
|
|
2063
|
+
<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>
|
|
2064
|
+
<li><a href="#tsconfigDevFile" 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<wbr/>File</span></a></li>
|
|
2065
|
+
<li><a href="#typescriptVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>typescript<wbr/>Version</span></a></li>
|
|
2066
|
+
<li><a href="#versionrcOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>versionrc<wbr/>Options</span></a></li>
|
|
2067
|
+
<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>
|
|
2068
|
+
<li><a href="#watchExcludes" 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/>Excludes</span></a></li>
|
|
2069
|
+
<li><a href="#watchIncludes" 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/>Includes</span></a></li>
|
|
2070
|
+
<li><a href="#workflowBootstrapSteps" class="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>
|
|
2071
|
+
<li><a href="#workflowContainerImage" class="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/>Container<wbr/>Image</span></a></li>
|
|
2072
|
+
<li><a href="#workflowGitIdentity" class="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/>Git<wbr/>Identity</span></a></li>
|
|
2073
|
+
<li><a href="#workflowNodeVersion" class="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/>Node<wbr/>Version</span></a></li>
|
|
2074
|
+
<li><a href="#workflowPackageCache" class="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>
|
|
2075
|
+
<li><a href="#workflowRunsOn" class="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/>Runs<wbr/>On</span></a></li></ul></div></details></div>
|
|
1907
2076
|
<div class="site-menu">
|
|
1908
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
2077
|
+
<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>
|
|
1909
2078
|
<ul class="tsd-small-nested-navigation">
|
|
1910
|
-
<li><a href="../classes/Datastore.html"><svg class="tsd-kind-icon"
|
|
1911
|
-
<li><a href="../classes/
|
|
1912
|
-
<li><a href="../classes/
|
|
1913
|
-
<li><a href="../classes/
|
|
1914
|
-
<li><a href="
|
|
1915
|
-
<li><a href="
|
|
1916
|
-
<li><a href="
|
|
1917
|
-
<li><a href="
|
|
1918
|
-
<li><a href="
|
|
2079
|
+
<li><a href="../classes/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>
|
|
2080
|
+
<li><a href="../classes/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>
|
|
2081
|
+
<li><a href="../classes/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>
|
|
2082
|
+
<li><a href="../classes/ServerlessProject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Serverless<wbr/>Project</span></a></li>
|
|
2083
|
+
<li><a href="../classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
2084
|
+
<li><a href="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>
|
|
2085
|
+
<li><a href="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>
|
|
2086
|
+
<li><a href="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>
|
|
2087
|
+
<li><a href="ServerlessProjectOptions.html" class="current"><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>
|
|
2088
|
+
<li><a href="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>
|
|
2089
|
+
<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>
|
|
1919
2090
|
<div class="tsd-generator">
|
|
1920
2091
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1921
2092
|
<div class="overlay"></div></body></html>
|