cdk-serverless 2.9.2 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/constructs/assets/main.js +3 -4
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +3 -18
- package/docs/constructs/classes/AssetCdn.html +168 -13
- package/docs/constructs/classes/BaseApi.html +175 -13
- package/docs/constructs/classes/CognitoAuthentication.html +184 -14
- package/docs/constructs/classes/GraphQlApi.html +467 -14
- package/docs/constructs/classes/LambdaFunction.html +1031 -81
- package/docs/constructs/classes/RestApi.html +352 -20
- package/docs/constructs/classes/SingleTableDatastore.html +160 -13
- package/docs/constructs/classes/Workflow.html +173 -13
- package/docs/constructs/index.html +83 -2
- package/docs/constructs/interfaces/AssetCdnProps.html +94 -4
- package/docs/constructs/interfaces/BaseApiProps.html +184 -20
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +177 -18
- package/docs/constructs/interfaces/GraphQlApiProps.html +199 -20
- package/docs/constructs/interfaces/ICognitoAuthentication.html +91 -3
- package/docs/constructs/interfaces/IJwtAuthentication.html +101 -5
- package/docs/constructs/interfaces/JsResolverOptions.html +103 -6
- package/docs/constructs/interfaces/LambdaFunctionProps.html +187 -18
- package/docs/constructs/interfaces/LambdaTracingOptions.html +89 -4
- package/docs/constructs/interfaces/RestApiProps.html +235 -26
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +107 -7
- package/docs/constructs/interfaces/SingleTableDesign.html +117 -7
- package/docs/constructs/interfaces/VtlResolverOptions.html +101 -5
- package/docs/constructs/interfaces/WorkflowProps.html +105 -2
- package/docs/constructs/modules.html +73 -4
- package/docs/constructs/types/LambdaOptions.html +62 -1
- package/docs/lambda/assets/main.js +3 -4
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +3 -18
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +292 -21
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +291 -20
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +292 -21
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +289 -20
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +284 -21
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +274 -20
- package/docs/lambda/classes/auth.JwtAuthorizer.html +268 -20
- package/docs/lambda/classes/errors.BadRequestError.html +164 -7
- package/docs/lambda/classes/errors.ForbiddenError.html +164 -7
- package/docs/lambda/classes/errors.HttpError.html +170 -7
- package/docs/lambda/classes/errors.NotFoundError.html +164 -7
- package/docs/lambda/classes/errors.UnauthenticatedError.html +164 -7
- package/docs/lambda/functions/api.createAppSyncHandler.html +80 -3
- package/docs/lambda/functions/api.createHttpHandler.html +78 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +78 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +78 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +76 -2
- package/docs/lambda/index.html +63 -2
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +102 -3
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +101 -3
- package/docs/lambda/interfaces/api.HttpResponseContext.html +98 -3
- package/docs/lambda/interfaces/api.Operation.html +92 -3
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +105 -3
- package/docs/lambda/modules/api.html +72 -4
- package/docs/lambda/modules/auth.html +58 -2
- package/docs/lambda/modules/errors.html +56 -2
- package/docs/lambda/modules.html +45 -2
- package/docs/lambda/types/api.APIGatewayv1Handler.html +62 -2
- package/docs/lambda/types/api.AppSyncHandler.html +82 -2
- package/docs/lambda/types/api.HttpHandler.html +84 -2
- package/docs/projen/assets/main.js +3 -4
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +3 -18
- package/docs/projen/classes/Datastore.html +230 -12
- package/docs/projen/classes/GraphQlApi.html +206 -12
- package/docs/projen/classes/RestApi.html +250 -12
- package/docs/projen/classes/ServerlessProject.html +1288 -135
- package/docs/projen/classes/Workflow.html +228 -12
- package/docs/projen/index.html +71 -2
- package/docs/projen/interfaces/DatastoreOptions.html +76 -2
- package/docs/projen/interfaces/GraphQlApiOptions.html +76 -2
- package/docs/projen/interfaces/RestApiOptions.html +76 -2
- package/docs/projen/interfaces/ServerlessProjectOptions.html +1826 -426
- package/docs/projen/interfaces/WorkflowOptions.html +76 -2
- package/docs/projen/modules.html +61 -4
- package/docs/projen/variables/PACKAGE_NAME.html +50 -1
- package/lib/constructs/func.d.ts +1 -0
- package/lib/constructs/func.js +8 -1
- package/package.json +3 -3
- package/docs/constructs/assets/navigation.js +0 -1
- package/docs/lambda/assets/navigation.js +0 -1
- package/docs/projen/assets/navigation.js +0 -1
|
@@ -1,4 +1,34 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerlessProjectOptions | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="ServerlessProjectOptions.html">ServerlessProjectOptions</a></li></ul><h1>Interface ServerlessProjectOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ServerlessProjectOptions </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#allowLibraryDependencies">allowLibraryDependencies</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#appEntrypoint">appEntrypoint</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#artifactsDirectory">artifactsDirectory</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#authorEmail">authorEmail</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#authorName">authorName</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#authorOrganization">authorOrganization</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#authorUrl">authorUrl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#autoApproveOptions">autoApproveOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">AutoApproveOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#autoApproveUpgrades">autoApproveUpgrades</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#autoDetectBin">autoDetectBin</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#autoMerge">autoMerge</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#autoMergeOptions">autoMergeOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">AutoMergeOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#bin">bin</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#bugsEmail">bugsEmail</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#bugsUrl">bugsUrl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#buildCommand">buildCommand</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#buildWorkflow">buildWorkflow</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#buildWorkflowTriggers">buildWorkflowTriggers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">Triggers</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#bundledDeps">bundledDeps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#bundlerOptions">bundlerOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">BundlerOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkAssert">cdkAssert</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkAssertions">cdkAssertions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkDependencies">cdkDependencies</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkDependenciesAsDeps">cdkDependenciesAsDeps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkTestDependencies">cdkTestDependencies</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkVersion">cdkVersion</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkVersionPinning">cdkVersionPinning</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#cdkout">cdkout</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#checkLicenses">checkLicenses</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">LicenseCheckerOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#clobber">clobber</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#codeArtifactOptions">codeArtifactOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">CodeArtifactOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#codeCov">codeCov</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#codeCovTokenSecret">codeCovTokenSecret</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#commitGenerated">commitGenerated</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#constructsVersion">constructsVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#context">context</a><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> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#copyrightOwner">copyrightOwner</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#copyrightPeriod">copyrightPeriod</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#defaultReleaseBranch">defaultReleaseBranch</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#dependabot">dependabot</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#dependabotOptions">dependabotOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">DependabotOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#deps">deps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#depsUpgrade">depsUpgrade</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#depsUpgradeOptions">depsUpgradeOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">UpgradeDependenciesOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#description">description</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#devContainer">devContainer</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#devDeps">devDeps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#disableTsconfig">disableTsconfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#disableTsconfigDev">disableTsconfigDev</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#docgen">docgen</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#docsDirectory">docsDirectory</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#edgeLambdaAutoDiscover">edgeLambdaAutoDiscover</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#entrypoint">entrypoint</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#entrypointTypes">entrypointTypes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#eslint">eslint</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#eslintOptions">eslintOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">EslintOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#experimentalIntegRunner">experimentalIntegRunner</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#featureFlags">featureFlags</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#gitIgnoreOptions">gitIgnoreOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">IgnoreFileOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#gitOptions">gitOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">GitOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#github">github</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#githubOptions">githubOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">GitHubOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#gitignore">gitignore</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#gitpod">gitpod</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#homepage">homepage</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#integrationTestAutoDiscover">integrationTestAutoDiscover</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#jest">jest</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#jestOptions">jestOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">JestOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#jsiiReleaseVersion">jsiiReleaseVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#keywords">keywords</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#lambdaAutoDiscover">lambdaAutoDiscover</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#lambdaExtensionAutoDiscover">lambdaExtensionAutoDiscover</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#lambdaOptions">lambdaOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">LambdaFunctionCommonOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#libdir">libdir</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#license">license</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#licensed">licensed</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#logging">logging</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">LoggerOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#majorVersion">majorVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#maxNodeVersion">maxNodeVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#mergify">mergify</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#mergifyOptions">mergifyOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">MergifyOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#minMajorVersion">minMajorVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#minNodeVersion">minNodeVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#mutableBuild">mutableBuild</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#name">name</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmAccess">npmAccess</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">NpmAccess</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmDistTag">npmDistTag</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmIgnoreOptions">npmIgnoreOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">IgnoreFileOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmRegistry">npmRegistry</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmRegistryUrl">npmRegistryUrl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmTokenSecret">npmTokenSecret</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmignore">npmignore</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#npmignoreEnabled">npmignoreEnabled</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#outdir">outdir</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#package">package</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#packageManager">packageManager</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">NodePackageManager</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#packageName">packageName</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#parent">parent</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">Project</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#peerDependencyOptions">peerDependencyOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">PeerDependencyOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#peerDeps">peerDeps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#pnpmVersion">pnpmVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#postBuildSteps">postBuildSteps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#prerelease">prerelease</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#prettier">prettier</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#prettierOptions">prettierOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">PrettierOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projectType">projectType</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ProjectType</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenCommand">projenCommand</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenCredentials">projenCredentials</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">GithubCredentials</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenDevDependency">projenDevDependency</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenTokenSecret">projenTokenSecret</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenVersion">projenVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenrcJs">projenrcJs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenrcJsOptions">projenrcJsOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ProjenrcOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenrcJson">projenrcJson</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenrcJsonOptions">projenrcJsonOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ProjenrcJsonOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenrcTs">projenrcTs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#projenrcTsOptions">projenrcTsOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ProjenrcOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#publishDryRun">publishDryRun</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#publishTasks">publishTasks</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#pullRequestTemplate">pullRequestTemplate</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#pullRequestTemplateContents">pullRequestTemplateContents</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#readme">readme</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">SampleReadmeProps</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releasableCommits">releasableCommits</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ReleasableCommits</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#release">release</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseBranches">releaseBranches</a><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> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseEveryCommit">releaseEveryCommit</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseFailureIssue">releaseFailureIssue</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseFailureIssueLabel">releaseFailureIssueLabel</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseSchedule">releaseSchedule</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseTagPrefix">releaseTagPrefix</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseToNpm">releaseToNpm</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseTrigger">releaseTrigger</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ReleaseTrigger</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseWorkflow">releaseWorkflow</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseWorkflowName">releaseWorkflowName</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#renovatebot">renovatebot</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#renovatebotOptions">renovatebotOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">RenovatebotOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#repository">repository</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#repositoryDirectory">repositoryDirectory</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#requireApproval">requireApproval</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ApprovalLevel</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#sampleCode">sampleCode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#scopedPackagesOptions">scopedPackagesOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#scripts">scripts</a><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> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#srcdir">srcdir</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#stability">stability</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#stale">stale</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#staleOptions">staleOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">StaleOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#testdir">testdir</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#tsJestOptions">tsJestOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">TsJestOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#tsconfig">tsconfig</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">TypescriptConfigOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#tsconfigDev">tsconfigDev</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">TypescriptConfigOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#tsconfigDevFile">tsconfigDevFile</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#typescriptVersion">typescriptVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#versionrcOptions">versionrcOptions</a><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><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#vscode">vscode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#watchExcludes">watchExcludes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#watchIncludes">watchIncludes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowBootstrapSteps">workflowBootstrapSteps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowContainerImage">workflowContainerImage</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowGitIdentity">workflowGitIdentity</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">GitIdentity</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowNodeVersion">workflowNodeVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowPackageCache">workflowPackageCache</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowRunsOn">workflowRunsOn</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#workflowRunsOnGroup">workflowRunsOnGroup</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">GroupRunnerOptions</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="ServerlessProjectOptions.html#yarnBerryOptions">yarnBerryOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type ">YarnBerryOptions</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type ">AwsCdkTypeScriptAppOptions</span><ul class="tsd-hierarchy"><li><span class="target">ServerlessProjectOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><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"><use href="#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerlessProjectOptions | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../modules.html">cdk-serverless</a></li>
|
|
16
|
+
<li><a href="ServerlessProjectOptions.html">ServerlessProjectOptions</a></li></ul>
|
|
17
|
+
<h1>Interface ServerlessProjectOptions</h1></div>
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
19
|
+
<h4>Hierarchy</h4>
|
|
20
|
+
<ul class="tsd-hierarchy">
|
|
21
|
+
<li><span class="tsd-signature-type ">AwsCdkTypeScriptAppOptions</span>
|
|
22
|
+
<ul class="tsd-hierarchy">
|
|
23
|
+
<li><span class="target">ServerlessProjectOptions</span></li></ul></li></ul></section>
|
|
24
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
25
|
+
<section class="tsd-panel tsd-index-panel">
|
|
26
|
+
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
27
|
+
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
28
|
+
<div class="tsd-accordion-details">
|
|
29
|
+
<section class="tsd-index-section">
|
|
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" 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>
|
|
2
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>
|
|
3
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>
|
|
4
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>
|
|
@@ -163,61 +193,186 @@
|
|
|
163
193
|
<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>
|
|
164
194
|
<a href="ServerlessProjectOptions.html#workflowRunsOnGroup" 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<wbr/>Group?</span></a>
|
|
165
195
|
<a href="ServerlessProjectOptions.html#yarnBerryOptions" 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>yarn<wbr/>Berry<wbr/>Options?</span></a>
|
|
166
|
-
</div></section></div></details></section></section
|
|
196
|
+
</div></section></div></details></section></section>
|
|
197
|
+
<section class="tsd-panel-group tsd-member-group">
|
|
198
|
+
<h2>Properties</h2>
|
|
199
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowLibraryDependencies" class="tsd-anchor"></a>
|
|
200
|
+
<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>
|
|
201
|
+
<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>
|
|
202
|
+
<div class="tsd-comment tsd-typography"><p>Allow the project to include <code>peerDependencies</code> and <code>bundledDependencies</code>.
|
|
167
203
|
This is normally only allowed for libraries. For apps, there's no meaning
|
|
168
204
|
for specifying these.</p>
|
|
169
|
-
</div
|
|
170
|
-
|
|
171
|
-
|
|
205
|
+
</div>
|
|
206
|
+
<div class="tsd-comment tsd-typography">
|
|
207
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
208
|
+
</code><button>Copy</button></pre>
|
|
209
|
+
</div><aside class="tsd-sources">
|
|
210
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.allowLibraryDependencies</p></aside></section>
|
|
211
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="appEntrypoint" class="tsd-anchor"></a>
|
|
212
|
+
<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>
|
|
213
|
+
<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>
|
|
214
|
+
<div class="tsd-comment tsd-typography"><p>The CDK app's entrypoint (relative to the source directory, which is
|
|
172
215
|
"src" by default).</p>
|
|
173
|
-
</div
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
</
|
|
177
|
-
</
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
</div
|
|
184
|
-
|
|
185
|
-
|
|
216
|
+
</div>
|
|
217
|
+
<div class="tsd-comment tsd-typography">
|
|
218
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"main.ts"</span>
|
|
219
|
+
</code><button>Copy</button></pre>
|
|
220
|
+
</div><aside class="tsd-sources">
|
|
221
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.appEntrypoint</p></aside></section>
|
|
222
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="artifactsDirectory" 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>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>
|
|
224
|
+
<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>
|
|
225
|
+
<div class="tsd-comment tsd-typography"><p>A directory which will contain build artifacts.</p>
|
|
226
|
+
</div>
|
|
227
|
+
<div class="tsd-comment tsd-typography">
|
|
228
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"dist"</span>
|
|
229
|
+
</code><button>Copy</button></pre>
|
|
230
|
+
</div><aside class="tsd-sources">
|
|
231
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.artifactsDirectory</p></aside></section>
|
|
232
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorEmail" class="tsd-anchor"></a>
|
|
233
|
+
<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>
|
|
234
|
+
<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>
|
|
235
|
+
<div class="tsd-comment tsd-typography"><p>Author's e-mail</p>
|
|
236
|
+
</div>
|
|
237
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
238
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorEmail</p></aside></section>
|
|
239
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorName" class="tsd-anchor"></a>
|
|
240
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>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>
|
|
241
|
+
<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>
|
|
242
|
+
<div class="tsd-comment tsd-typography"><p>Author's name</p>
|
|
243
|
+
</div>
|
|
244
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
245
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorName</p></aside></section>
|
|
246
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorOrganization" 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>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>
|
|
248
|
+
<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>
|
|
249
|
+
<div class="tsd-comment tsd-typography"><p>Is the author an organization</p>
|
|
250
|
+
</div>
|
|
251
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
252
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorOrganization</p></aside></section>
|
|
253
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="authorUrl" class="tsd-anchor"></a>
|
|
254
|
+
<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>
|
|
255
|
+
<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>
|
|
256
|
+
<div class="tsd-comment tsd-typography"><p>Author's URL / Website</p>
|
|
257
|
+
</div>
|
|
258
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
259
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.authorUrl</p></aside></section>
|
|
260
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveOptions" class="tsd-anchor"></a>
|
|
261
|
+
<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>
|
|
262
|
+
<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>
|
|
263
|
+
<div class="tsd-comment tsd-typography"><p>Enable and configure the 'auto approve' workflow.</p>
|
|
264
|
+
</div>
|
|
265
|
+
<div class="tsd-comment tsd-typography">
|
|
266
|
+
<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>
|
|
267
|
+
</code><button>Copy</button></pre>
|
|
268
|
+
</div><aside class="tsd-sources">
|
|
269
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveOptions</p></aside></section>
|
|
270
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoApproveUpgrades" class="tsd-anchor"></a>
|
|
271
|
+
<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>
|
|
272
|
+
<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>
|
|
273
|
+
<div class="tsd-comment tsd-typography"><p>Automatically approve deps upgrade PRs, allowing them to be
|
|
186
274
|
merged by mergify (if configued).</p>
|
|
187
275
|
<p>Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
|
|
188
|
-
</div
|
|
189
|
-
|
|
190
|
-
|
|
276
|
+
</div>
|
|
277
|
+
<div class="tsd-comment tsd-typography">
|
|
278
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span>
|
|
279
|
+
</code><button>Copy</button></pre>
|
|
280
|
+
</div><aside class="tsd-sources">
|
|
281
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveUpgrades</p></aside></section>
|
|
282
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoDetectBin" class="tsd-anchor"></a>
|
|
283
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>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>
|
|
284
|
+
<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>
|
|
285
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add all executables under the <code>bin</code> directory to your
|
|
191
286
|
<code>package.json</code> file under the <code>bin</code> section.</p>
|
|
192
|
-
</div
|
|
193
|
-
|
|
194
|
-
|
|
287
|
+
</div>
|
|
288
|
+
<div class="tsd-comment tsd-typography">
|
|
289
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
290
|
+
</code><button>Copy</button></pre>
|
|
291
|
+
</div><aside class="tsd-sources">
|
|
292
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoDetectBin</p></aside></section>
|
|
293
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMerge" class="tsd-anchor"></a>
|
|
294
|
+
<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>
|
|
295
|
+
<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>
|
|
296
|
+
<div class="tsd-comment tsd-typography"><p>Enable automatic merging on GitHub. Has no effect if <code>github.mergify</code>
|
|
195
297
|
is set to false.</p>
|
|
196
|
-
</div
|
|
197
|
-
|
|
198
|
-
|
|
298
|
+
</div>
|
|
299
|
+
<div class="tsd-comment tsd-typography">
|
|
300
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
301
|
+
</code><button>Copy</button></pre>
|
|
302
|
+
</div><aside class="tsd-sources">
|
|
303
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMerge</p></aside></section>
|
|
304
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="autoMergeOptions" class="tsd-anchor"></a>
|
|
305
|
+
<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>
|
|
306
|
+
<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>
|
|
307
|
+
<div class="tsd-comment tsd-typography"><p>Configure options for automatic merging on GitHub. Has no effect if
|
|
199
308
|
<code>github.mergify</code> or <code>autoMerge</code> is set to false.</p>
|
|
200
|
-
</div
|
|
309
|
+
</div>
|
|
310
|
+
<div class="tsd-comment tsd-typography">
|
|
311
|
+
<h4>Default</h4><ul>
|
|
201
312
|
<li>see defaults in <code>AutoMergeOptions</code></li>
|
|
202
313
|
</ul>
|
|
203
|
-
</div><aside class="tsd-sources"
|
|
314
|
+
</div><aside class="tsd-sources">
|
|
315
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMergeOptions</p></aside></section>
|
|
316
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bin" class="tsd-anchor"></a>
|
|
317
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>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>
|
|
318
|
+
<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>
|
|
319
|
+
<div class="tsd-comment tsd-typography"><p>Binary programs vended with your module.</p>
|
|
204
320
|
<p>You can use this option to add/customize how binaries are represented in
|
|
205
321
|
your <code>package.json</code>, but unless <code>autoDetectBin</code> is <code>false</code>, every
|
|
206
322
|
executable file under <code>bin</code> will automatically be added to this section.</p>
|
|
207
|
-
</div
|
|
208
|
-
|
|
209
|
-
|
|
323
|
+
</div>
|
|
324
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
325
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bin</p></aside></section>
|
|
326
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bugsEmail" class="tsd-anchor"></a>
|
|
327
|
+
<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>
|
|
328
|
+
<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>
|
|
329
|
+
<div class="tsd-comment tsd-typography"><p>The email address to which issues should be reported.</p>
|
|
330
|
+
</div>
|
|
331
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
332
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsEmail</p></aside></section>
|
|
333
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bugsUrl" class="tsd-anchor"></a>
|
|
334
|
+
<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>
|
|
335
|
+
<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>
|
|
336
|
+
<div class="tsd-comment tsd-typography"><p>The url to your project's issue tracker.</p>
|
|
337
|
+
</div>
|
|
338
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
339
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bugsUrl</p></aside></section>
|
|
340
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildCommand" class="tsd-anchor"></a>
|
|
341
|
+
<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>
|
|
342
|
+
<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>
|
|
343
|
+
<div class="tsd-comment tsd-typography"><p>A command to execute before synthesis. This command will be called when
|
|
210
344
|
running <code>cdk synth</code> or when <code>cdk watch</code> identifies a change in your source
|
|
211
345
|
code before redeployment.</p>
|
|
212
|
-
</div
|
|
213
|
-
|
|
214
|
-
</
|
|
215
|
-
</
|
|
216
|
-
</
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
</code
|
|
220
|
-
|
|
346
|
+
</div>
|
|
347
|
+
<div class="tsd-comment tsd-typography">
|
|
348
|
+
<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>
|
|
349
|
+
</code><button>Copy</button></pre>
|
|
350
|
+
</div><aside class="tsd-sources">
|
|
351
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildCommand</p></aside></section>
|
|
352
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflow" class="tsd-anchor"></a>
|
|
353
|
+
<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>
|
|
354
|
+
<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>
|
|
355
|
+
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
|
|
356
|
+
</div>
|
|
357
|
+
<div class="tsd-comment tsd-typography">
|
|
358
|
+
<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>
|
|
359
|
+
</code><button>Copy</button></pre>
|
|
360
|
+
</div><aside class="tsd-sources">
|
|
361
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflow</p></aside></section>
|
|
362
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="buildWorkflowTriggers" class="tsd-anchor"></a>
|
|
363
|
+
<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>
|
|
364
|
+
<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>
|
|
365
|
+
<div class="tsd-comment tsd-typography"><p>Build workflow triggers</p>
|
|
366
|
+
</div>
|
|
367
|
+
<div class="tsd-comment tsd-typography">
|
|
368
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"{ pullRequest: {}, workflowDispatch: {} }"</span>
|
|
369
|
+
</code><button>Copy</button></pre>
|
|
370
|
+
</div><aside class="tsd-sources">
|
|
371
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflowTriggers</p></aside></section>
|
|
372
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundledDeps" class="tsd-anchor"></a>
|
|
373
|
+
<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>
|
|
374
|
+
<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>
|
|
375
|
+
<div class="tsd-comment tsd-typography"><p>List of dependencies to bundle into this module. These modules will be
|
|
221
376
|
added both to the <code>dependencies</code> section and <code>bundledDependencies</code> section of
|
|
222
377
|
your <code>package.json</code>.</p>
|
|
223
378
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
@@ -226,112 +381,314 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
226
381
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
227
382
|
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
228
383
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
229
|
-
</div
|
|
230
|
-
|
|
384
|
+
</div>
|
|
385
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
386
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundledDeps</p></aside></section>
|
|
387
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bundlerOptions" class="tsd-anchor"></a>
|
|
388
|
+
<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>
|
|
389
|
+
<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>
|
|
390
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>Bundler</code>.</p>
|
|
391
|
+
</div>
|
|
392
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
393
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.bundlerOptions</p></aside></section>
|
|
394
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkAssert" class="tsd-anchor"></a>
|
|
395
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">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>
|
|
396
|
+
<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>
|
|
397
|
+
<div class="tsd-comment tsd-typography"><p>Warning: NodeJS only.
|
|
231
398
|
Install the @aws-cdk/assert library?</p>
|
|
232
|
-
</div
|
|
399
|
+
</div>
|
|
400
|
+
<div class="tsd-comment tsd-typography">
|
|
401
|
+
<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>
|
|
233
402
|
</code><button>Copy</button></pre>
|
|
403
|
+
|
|
234
404
|
<h4>Deprecated</h4><p>The @aws-cdk/assert library is deprecated in favor of
|
|
235
405
|
@aws-cdk/assertions (in V1) and included in <code>aws-cdk-lib</code> for V2.</p>
|
|
236
|
-
</div><aside class="tsd-sources"
|
|
406
|
+
</div><aside class="tsd-sources">
|
|
407
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssert</p></aside></section>
|
|
408
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkAssertions" class="tsd-anchor"></a>
|
|
409
|
+
<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>
|
|
410
|
+
<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>
|
|
411
|
+
<div class="tsd-comment tsd-typography"><p>Install the assertions library?</p>
|
|
237
412
|
<p>Only needed for CDK 1.x. If using CDK 2.x then
|
|
238
413
|
assertions is already included in 'aws-cdk-lib'</p>
|
|
239
|
-
</div
|
|
240
|
-
|
|
241
|
-
</
|
|
242
|
-
</
|
|
243
|
-
</div><aside class="tsd-sources"
|
|
414
|
+
</div>
|
|
415
|
+
<div class="tsd-comment tsd-typography">
|
|
416
|
+
<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>
|
|
417
|
+
</code><button>Copy</button></pre>
|
|
418
|
+
</div><aside class="tsd-sources">
|
|
419
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssertions</p></aside></section>
|
|
420
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependencies" class="tsd-anchor"></a>
|
|
421
|
+
<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>
|
|
422
|
+
<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>
|
|
423
|
+
<div class="tsd-comment tsd-typography"><p>Which AWS CDKv1 modules this project requires</p>
|
|
424
|
+
</div>
|
|
425
|
+
<div class="tsd-comment tsd-typography">
|
|
426
|
+
<h4>Deprecated</h4><p>For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)</p>
|
|
427
|
+
</div><aside class="tsd-sources">
|
|
428
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependencies</p></aside></section>
|
|
429
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkDependenciesAsDeps" class="tsd-anchor"></a>
|
|
430
|
+
<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>
|
|
431
|
+
<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>
|
|
432
|
+
<div class="tsd-comment tsd-typography"><p>If this is enabled (default), all modules declared in <code>cdkDependencies</code> will be also added as
|
|
244
433
|
normal <code>dependencies</code> (as well as <code>peerDependencies</code>).</p>
|
|
245
434
|
<p>This is to ensure that downstream consumers actually have your CDK dependencies installed
|
|
246
435
|
when using npm < 7 or yarn, where peer dependencies are not automatically installed.
|
|
247
436
|
If this is disabled, <code>cdkDependencies</code> will be added to <code>devDependencies</code> to ensure
|
|
248
437
|
they are present during development.</p>
|
|
249
438
|
<p>Note: this setting only applies to construct library projects</p>
|
|
250
|
-
</div
|
|
439
|
+
</div>
|
|
440
|
+
<div class="tsd-comment tsd-typography">
|
|
441
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
251
442
|
</code><button>Copy</button></pre>
|
|
443
|
+
|
|
252
444
|
<h4>Deprecated</h4><p>Not supported in CDK v2.</p>
|
|
253
|
-
</div><aside class="tsd-sources"
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
</
|
|
258
|
-
|
|
445
|
+
</div><aside class="tsd-sources">
|
|
446
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkDependenciesAsDeps</p></aside></section>
|
|
447
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkTestDependencies" class="tsd-anchor"></a>
|
|
448
|
+
<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>
|
|
449
|
+
<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>
|
|
450
|
+
<div class="tsd-comment tsd-typography"><p>AWS CDK modules required for testing.</p>
|
|
451
|
+
</div>
|
|
452
|
+
<div class="tsd-comment tsd-typography">
|
|
453
|
+
<h4>Deprecated</h4><p>For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead</p>
|
|
454
|
+
</div><aside class="tsd-sources">
|
|
455
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkTestDependencies</p></aside></section>
|
|
456
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersion" class="tsd-anchor"></a>
|
|
457
|
+
<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>
|
|
458
|
+
<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>
|
|
459
|
+
<div class="tsd-comment tsd-typography"><p>Minimum version of the AWS CDK to depend on.</p>
|
|
460
|
+
</div>
|
|
461
|
+
<div class="tsd-comment tsd-typography">
|
|
462
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"2.1.0"</span>
|
|
463
|
+
</code><button>Copy</button></pre>
|
|
464
|
+
</div><aside class="tsd-sources">
|
|
465
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersion</p></aside></section>
|
|
466
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkVersionPinning" class="tsd-anchor"></a>
|
|
467
|
+
<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>
|
|
468
|
+
<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>
|
|
469
|
+
<div class="tsd-comment tsd-typography"><p>Use pinned version instead of caret version for CDK.</p>
|
|
259
470
|
<p>You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
|
|
260
471
|
If you use experimental features this will let you define the moment you include breaking changes.</p>
|
|
261
|
-
</div
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
472
|
+
</div>
|
|
473
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
474
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkVersionPinning</p></aside></section>
|
|
475
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cdkout" class="tsd-anchor"></a>
|
|
476
|
+
<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>
|
|
477
|
+
<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>
|
|
478
|
+
<div class="tsd-comment tsd-typography"><p>cdk.out directory.</p>
|
|
479
|
+
</div>
|
|
480
|
+
<div class="tsd-comment tsd-typography">
|
|
481
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"cdk.out"</span>
|
|
482
|
+
</code><button>Copy</button></pre>
|
|
483
|
+
</div><aside class="tsd-sources">
|
|
484
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkout</p></aside></section>
|
|
485
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="checkLicenses" class="tsd-anchor"></a>
|
|
486
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>check<wbr/>Licenses</span><a href="#checkLicenses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
487
|
+
<div class="tsd-signature"><span class="tsd-kind-property">check<wbr/>Licenses</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">LicenseCheckerOptions</span></div>
|
|
488
|
+
<div class="tsd-comment tsd-typography"><p>Configure which licenses should be deemed acceptable for use by dependencies</p>
|
|
265
489
|
<p>This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.</p>
|
|
266
|
-
</div
|
|
267
|
-
|
|
268
|
-
</
|
|
269
|
-
</
|
|
270
|
-
</
|
|
271
|
-
|
|
490
|
+
</div>
|
|
491
|
+
<div class="tsd-comment tsd-typography">
|
|
492
|
+
<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">license</span><span class="hl-1"> </span><span class="hl-4">checks</span><span class="hl-1"> </span><span class="hl-4">are</span><span class="hl-1"> </span><span class="hl-4">run</span><span class="hl-1"> </span><span class="hl-4">during</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">build</span><span class="hl-1"> </span><span class="hl-4">and</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-4">licenses</span><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">accepted</span>
|
|
493
|
+
</code><button>Copy</button></pre>
|
|
494
|
+
</div><aside class="tsd-sources">
|
|
495
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.checkLicenses</p></aside></section>
|
|
496
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clobber" class="tsd-anchor"></a>
|
|
497
|
+
<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>
|
|
498
|
+
<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>
|
|
499
|
+
<div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
|
|
500
|
+
</div>
|
|
501
|
+
<div class="tsd-comment tsd-typography">
|
|
502
|
+
<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>
|
|
503
|
+
</code><button>Copy</button></pre>
|
|
504
|
+
</div><aside class="tsd-sources">
|
|
505
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.clobber</p></aside></section>
|
|
506
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeArtifactOptions" class="tsd-anchor"></a>
|
|
507
|
+
<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>
|
|
508
|
+
<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>
|
|
509
|
+
<div class="tsd-comment tsd-typography"><p>Options for npm packages using AWS CodeArtifact.
|
|
272
510
|
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
|
|
273
|
-
</div
|
|
274
|
-
|
|
275
|
-
|
|
511
|
+
</div>
|
|
512
|
+
<div class="tsd-comment tsd-typography">
|
|
513
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">undefined</span>
|
|
514
|
+
</code><button>Copy</button></pre>
|
|
515
|
+
</div><aside class="tsd-sources">
|
|
516
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeArtifactOptions</p></aside></section>
|
|
517
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCov" class="tsd-anchor"></a>
|
|
518
|
+
<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>
|
|
519
|
+
<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>
|
|
520
|
+
<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>
|
|
276
521
|
Uses codecov/codecov-action@v3
|
|
277
522
|
A secret is required for private repos. Configured with <code>@codeCovTokenSecret</code></p>
|
|
278
|
-
</div
|
|
279
|
-
|
|
280
|
-
|
|
523
|
+
</div>
|
|
524
|
+
<div class="tsd-comment tsd-typography">
|
|
525
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
526
|
+
</code><button>Copy</button></pre>
|
|
527
|
+
</div><aside class="tsd-sources">
|
|
528
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCov</p></aside></section>
|
|
529
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="codeCovTokenSecret" class="tsd-anchor"></a>
|
|
530
|
+
<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>
|
|
531
|
+
<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>
|
|
532
|
+
<div class="tsd-comment tsd-typography"><p>Define the secret name for a specified <a href="https://codecov.io/">https://codecov.io/</a> token
|
|
281
533
|
A secret is required to send coverage for private repositories</p>
|
|
282
|
-
</div
|
|
283
|
-
|
|
284
|
-
</
|
|
285
|
-
</
|
|
286
|
-
</
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
</code
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
</
|
|
293
|
-
|
|
294
|
-
</
|
|
534
|
+
</div>
|
|
535
|
+
<div class="tsd-comment tsd-typography">
|
|
536
|
+
<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>
|
|
537
|
+
</code><button>Copy</button></pre>
|
|
538
|
+
</div><aside class="tsd-sources">
|
|
539
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCovTokenSecret</p></aside></section>
|
|
540
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="commitGenerated" class="tsd-anchor"></a>
|
|
541
|
+
<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>
|
|
542
|
+
<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>
|
|
543
|
+
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
544
|
+
</div>
|
|
545
|
+
<div class="tsd-comment tsd-typography">
|
|
546
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
547
|
+
</code><button>Copy</button></pre>
|
|
548
|
+
</div><aside class="tsd-sources">
|
|
549
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.commitGenerated</p></aside></section>
|
|
550
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="constructsVersion" class="tsd-anchor"></a>
|
|
551
|
+
<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>
|
|
552
|
+
<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>
|
|
553
|
+
<div class="tsd-comment tsd-typography"><p>Minimum version of the <code>constructs</code> library to depend on.</p>
|
|
554
|
+
</div>
|
|
555
|
+
<div class="tsd-comment tsd-typography">
|
|
556
|
+
<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>
|
|
557
|
+
</code><button>Copy</button></pre>
|
|
558
|
+
</div><aside class="tsd-sources">
|
|
559
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.constructsVersion</p></aside></section>
|
|
560
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="context" class="tsd-anchor"></a>
|
|
561
|
+
<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>
|
|
562
|
+
<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>
|
|
563
|
+
<div class="tsd-comment tsd-typography"><p>Additional context to include in <code>cdk.json</code>.</p>
|
|
564
|
+
</div>
|
|
565
|
+
<div class="tsd-type-declaration">
|
|
566
|
+
<h4>Type declaration</h4>
|
|
567
|
+
<ul class="tsd-parameters">
|
|
568
|
+
<li class="tsd-parameter-index-signature">
|
|
569
|
+
<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>
|
|
570
|
+
<div class="tsd-comment tsd-typography">
|
|
571
|
+
<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>
|
|
572
|
+
</code><button>Copy</button></pre>
|
|
573
|
+
</div><aside class="tsd-sources">
|
|
574
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.context</p></aside></section>
|
|
575
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyrightOwner" class="tsd-anchor"></a>
|
|
576
|
+
<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>
|
|
577
|
+
<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>
|
|
578
|
+
<div class="tsd-comment tsd-typography"><p>License copyright owner.</p>
|
|
579
|
+
</div>
|
|
580
|
+
<div class="tsd-comment tsd-typography">
|
|
581
|
+
<h4>Default</h4><ul>
|
|
295
582
|
<li>defaults to the value of authorName or "" if <code>authorName</code> is undefined.</li>
|
|
296
583
|
</ul>
|
|
297
|
-
</div><aside class="tsd-sources"
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
</div
|
|
584
|
+
</div><aside class="tsd-sources">
|
|
585
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightOwner</p></aside></section>
|
|
586
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyrightPeriod" class="tsd-anchor"></a>
|
|
587
|
+
<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>
|
|
588
|
+
<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>
|
|
589
|
+
<div class="tsd-comment tsd-typography"><p>The copyright years to put in the LICENSE file.</p>
|
|
590
|
+
</div>
|
|
591
|
+
<div class="tsd-comment tsd-typography">
|
|
592
|
+
<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>
|
|
593
|
+
</code><button>Copy</button></pre>
|
|
594
|
+
</div><aside class="tsd-sources">
|
|
595
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.copyrightPeriod</p></aside></section>
|
|
596
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultReleaseBranch" class="tsd-anchor"></a>
|
|
597
|
+
<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>
|
|
598
|
+
<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>
|
|
599
|
+
<div class="tsd-comment tsd-typography"><p>The name of the main release branch.</p>
|
|
600
|
+
</div>
|
|
601
|
+
<div class="tsd-comment tsd-typography">
|
|
602
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"main"</span>
|
|
603
|
+
</code><button>Copy</button></pre>
|
|
604
|
+
</div><aside class="tsd-sources">
|
|
605
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.defaultReleaseBranch</p></aside></section>
|
|
606
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabot" class="tsd-anchor"></a>
|
|
607
|
+
<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>
|
|
608
|
+
<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>
|
|
609
|
+
<div class="tsd-comment tsd-typography"><p>Use dependabot to handle dependency upgrades.
|
|
304
610
|
Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
305
|
-
</div
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
</
|
|
309
|
-
</
|
|
310
|
-
|
|
611
|
+
</div>
|
|
612
|
+
<div class="tsd-comment tsd-typography">
|
|
613
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
614
|
+
</code><button>Copy</button></pre>
|
|
615
|
+
</div><aside class="tsd-sources">
|
|
616
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabot</p></aside></section>
|
|
617
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dependabotOptions" 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>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>
|
|
619
|
+
<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>
|
|
620
|
+
<div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
|
|
621
|
+
</div>
|
|
622
|
+
<div class="tsd-comment tsd-typography">
|
|
623
|
+
<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>
|
|
624
|
+
</code><button>Copy</button></pre>
|
|
625
|
+
</div><aside class="tsd-sources">
|
|
626
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabotOptions</p></aside></section>
|
|
627
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deps" class="tsd-anchor"></a>
|
|
628
|
+
<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>
|
|
629
|
+
<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>
|
|
630
|
+
<div class="tsd-comment tsd-typography"><p>Runtime dependencies of this module.</p>
|
|
311
631
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
312
632
|
<code>express</code>). This will behave similar to <code>yarn add</code> or <code>npm install</code> in the
|
|
313
633
|
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
314
634
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
315
635
|
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
316
636
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
317
|
-
</div
|
|
637
|
+
</div>
|
|
638
|
+
<div class="tsd-comment tsd-typography">
|
|
639
|
+
<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>
|
|
318
640
|
</code><button>Copy</button></pre>
|
|
641
|
+
|
|
319
642
|
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
320
643
|
</code><button>Copy</button></pre>
|
|
321
|
-
|
|
644
|
+
|
|
645
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
646
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.deps</p></aside></section>
|
|
647
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgrade" 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>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>
|
|
649
|
+
<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>
|
|
650
|
+
<div class="tsd-comment tsd-typography"><p>Use tasks and github workflows to handle dependency upgrades.
|
|
322
651
|
Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
323
|
-
</div
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
</
|
|
327
|
-
</
|
|
328
|
-
|
|
652
|
+
</div>
|
|
653
|
+
<div class="tsd-comment tsd-typography">
|
|
654
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
655
|
+
</code><button>Copy</button></pre>
|
|
656
|
+
</div><aside class="tsd-sources">
|
|
657
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgrade</p></aside></section>
|
|
658
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="depsUpgradeOptions" class="tsd-anchor"></a>
|
|
659
|
+
<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>
|
|
660
|
+
<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>
|
|
661
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
|
|
662
|
+
</div>
|
|
663
|
+
<div class="tsd-comment tsd-typography">
|
|
664
|
+
<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>
|
|
665
|
+
</code><button>Copy</button></pre>
|
|
666
|
+
</div><aside class="tsd-sources">
|
|
667
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgradeOptions</p></aside></section>
|
|
668
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="description" class="tsd-anchor"></a>
|
|
669
|
+
<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>
|
|
670
|
+
<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>
|
|
671
|
+
<div class="tsd-comment tsd-typography"><p>The description is just a string that helps people understand the purpose of the package.
|
|
329
672
|
It can be used when searching for packages in a package manager as well.
|
|
330
673
|
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>
|
|
331
|
-
</div
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
674
|
+
</div>
|
|
675
|
+
<div class="tsd-comment tsd-typography">
|
|
676
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
677
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.description</p></aside></section>
|
|
678
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devContainer" class="tsd-anchor"></a>
|
|
679
|
+
<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>
|
|
680
|
+
<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>
|
|
681
|
+
<div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces)</p>
|
|
682
|
+
</div>
|
|
683
|
+
<div class="tsd-comment tsd-typography">
|
|
684
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
685
|
+
</code><button>Copy</button></pre>
|
|
686
|
+
</div><aside class="tsd-sources">
|
|
687
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devContainer</p></aside></section>
|
|
688
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="devDeps" class="tsd-anchor"></a>
|
|
689
|
+
<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>
|
|
690
|
+
<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>
|
|
691
|
+
<div class="tsd-comment tsd-typography"><p>Build dependencies for this module. These dependencies will only be
|
|
335
692
|
available in your build environment but will not be fetched when this
|
|
336
693
|
module is consumed.</p>
|
|
337
694
|
<p>The recommendation is to only specify the module name here (e.g.
|
|
@@ -340,185 +697,554 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
340
697
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
341
698
|
the same syntax passed to <code>npm i</code> or <code>yarn add</code> (e.g. <code>express@^2</code>) and
|
|
342
699
|
this will be what you <code>package.json</code> will eventually include.</p>
|
|
343
|
-
</div
|
|
700
|
+
</div>
|
|
701
|
+
<div class="tsd-comment tsd-typography">
|
|
702
|
+
<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>
|
|
344
703
|
</code><button>Copy</button></pre>
|
|
704
|
+
|
|
345
705
|
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
346
706
|
</code><button>Copy</button></pre>
|
|
347
|
-
|
|
707
|
+
|
|
708
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
709
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devDeps</p></aside></section>
|
|
710
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfig" class="tsd-anchor"></a>
|
|
711
|
+
<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>
|
|
712
|
+
<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>
|
|
713
|
+
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.json</code> file (used by jsii projects since
|
|
348
714
|
tsconfig.json is generated by the jsii compiler).</p>
|
|
349
|
-
</div
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
</
|
|
353
|
-
</
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
</code
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
</
|
|
360
|
-
|
|
715
|
+
</div>
|
|
716
|
+
<div class="tsd-comment tsd-typography">
|
|
717
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
718
|
+
</code><button>Copy</button></pre>
|
|
719
|
+
</div><aside class="tsd-sources">
|
|
720
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfig</p></aside></section>
|
|
721
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="disableTsconfigDev" class="tsd-anchor"></a>
|
|
722
|
+
<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>
|
|
723
|
+
<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>
|
|
724
|
+
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.dev.json</code> file.</p>
|
|
725
|
+
</div>
|
|
726
|
+
<div class="tsd-comment tsd-typography">
|
|
727
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
728
|
+
</code><button>Copy</button></pre>
|
|
729
|
+
</div><aside class="tsd-sources">
|
|
730
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfigDev</p></aside></section>
|
|
731
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docgen" class="tsd-anchor"></a>
|
|
732
|
+
<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>
|
|
733
|
+
<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>
|
|
734
|
+
<div class="tsd-comment tsd-typography"><p>Docgen by Typedoc</p>
|
|
735
|
+
</div>
|
|
736
|
+
<div class="tsd-comment tsd-typography">
|
|
737
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
738
|
+
</code><button>Copy</button></pre>
|
|
739
|
+
</div><aside class="tsd-sources">
|
|
740
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docgen</p></aside></section>
|
|
741
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="docsDirectory" 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>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>
|
|
743
|
+
<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>
|
|
744
|
+
<div class="tsd-comment tsd-typography"><p>Docs directory</p>
|
|
745
|
+
</div>
|
|
746
|
+
<div class="tsd-comment tsd-typography">
|
|
747
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"docs"</span>
|
|
748
|
+
</code><button>Copy</button></pre>
|
|
749
|
+
</div><aside class="tsd-sources">
|
|
750
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docsDirectory</p></aside></section>
|
|
751
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="edgeLambdaAutoDiscover" class="tsd-anchor"></a>
|
|
752
|
+
<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>
|
|
753
|
+
<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>
|
|
754
|
+
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>cloudfront.experimental.EdgeFunction</code> for each
|
|
361
755
|
<code>.edge-lambda.ts</code> handler in your source tree. If this is disabled, you can
|
|
362
756
|
manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
363
|
-
</div
|
|
364
|
-
|
|
365
|
-
|
|
757
|
+
</div>
|
|
758
|
+
<div class="tsd-comment tsd-typography">
|
|
759
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
760
|
+
</code><button>Copy</button></pre>
|
|
761
|
+
</div><aside class="tsd-sources">
|
|
762
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.edgeLambdaAutoDiscover</p></aside></section>
|
|
763
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypoint" 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>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>
|
|
765
|
+
<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>
|
|
766
|
+
<div class="tsd-comment tsd-typography"><p>Module entrypoint (<code>main</code> in <code>package.json</code>)</p>
|
|
366
767
|
<p>Set to an empty string to not include <code>main</code> in your package.json</p>
|
|
367
|
-
</div
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
</
|
|
371
|
-
</
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
</code
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
</
|
|
378
|
-
|
|
379
|
-
</
|
|
380
|
-
</code><button>Copy</button></pre>
|
|
381
|
-
</div><aside class="tsd-sources"
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
768
|
+
</div>
|
|
769
|
+
<div class="tsd-comment tsd-typography">
|
|
770
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"lib/index.js"</span>
|
|
771
|
+
</code><button>Copy</button></pre>
|
|
772
|
+
</div><aside class="tsd-sources">
|
|
773
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypoint</p></aside></section>
|
|
774
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entrypointTypes" class="tsd-anchor"></a>
|
|
775
|
+
<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>
|
|
776
|
+
<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>
|
|
777
|
+
<div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
|
|
778
|
+
</div>
|
|
779
|
+
<div class="tsd-comment tsd-typography">
|
|
780
|
+
<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>
|
|
781
|
+
</code><button>Copy</button></pre>
|
|
782
|
+
</div><aside class="tsd-sources">
|
|
783
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypointTypes</p></aside></section>
|
|
784
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslint" class="tsd-anchor"></a>
|
|
785
|
+
<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>
|
|
786
|
+
<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>
|
|
787
|
+
<div class="tsd-comment tsd-typography"><p>Setup eslint.</p>
|
|
788
|
+
</div>
|
|
789
|
+
<div class="tsd-comment tsd-typography">
|
|
790
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
791
|
+
</code><button>Copy</button></pre>
|
|
792
|
+
</div><aside class="tsd-sources">
|
|
793
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslint</p></aside></section>
|
|
794
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eslintOptions" class="tsd-anchor"></a>
|
|
795
|
+
<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>
|
|
796
|
+
<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>
|
|
797
|
+
<div class="tsd-comment tsd-typography"><p>Eslint options</p>
|
|
798
|
+
</div>
|
|
799
|
+
<div class="tsd-comment tsd-typography">
|
|
800
|
+
<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>
|
|
801
|
+
</code><button>Copy</button></pre>
|
|
802
|
+
</div><aside class="tsd-sources">
|
|
803
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslintOptions</p></aside></section>
|
|
804
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="experimentalIntegRunner" class="tsd-anchor"></a>
|
|
805
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <code class="tsd-tag ts-flagExperimental">Experimental</code> <span>experimental<wbr/>Integ<wbr/>Runner</span><a href="#experimentalIntegRunner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
806
|
+
<div class="tsd-signature"><span class="tsd-kind-property">experimental<wbr/>Integ<wbr/>Runner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
807
|
+
<div class="tsd-comment tsd-typography"><p>Enable experimental support for the AWS CDK integ-runner.</p>
|
|
808
|
+
</div>
|
|
809
|
+
<div class="tsd-comment tsd-typography">
|
|
810
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span><br/><span class="hl-1">@</span><span class="hl-4">experimental</span>
|
|
811
|
+
</code><button>Copy</button></pre>
|
|
812
|
+
</div><aside class="tsd-sources">
|
|
813
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.experimentalIntegRunner</p></aside></section>
|
|
814
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="featureFlags" class="tsd-anchor"></a>
|
|
815
|
+
<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>
|
|
816
|
+
<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>
|
|
817
|
+
<div class="tsd-comment tsd-typography"><p>Include all feature flags in cdk.json</p>
|
|
818
|
+
</div>
|
|
819
|
+
<div class="tsd-comment tsd-typography">
|
|
820
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
821
|
+
</code><button>Copy</button></pre>
|
|
822
|
+
</div><aside class="tsd-sources">
|
|
823
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.featureFlags</p></aside></section>
|
|
824
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitIgnoreOptions" class="tsd-anchor"></a>
|
|
825
|
+
<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>
|
|
826
|
+
<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>
|
|
827
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for .gitignore file</p>
|
|
828
|
+
</div>
|
|
829
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
830
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitIgnoreOptions</p></aside></section>
|
|
831
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitOptions" class="tsd-anchor"></a>
|
|
832
|
+
<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>
|
|
833
|
+
<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>
|
|
834
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for git</p>
|
|
835
|
+
</div>
|
|
836
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
837
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitOptions</p></aside></section>
|
|
838
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="github" class="tsd-anchor"></a>
|
|
839
|
+
<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>
|
|
840
|
+
<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>
|
|
841
|
+
<div class="tsd-comment tsd-typography"><p>Enable GitHub integration.</p>
|
|
387
842
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
388
|
-
</div
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
</
|
|
392
|
-
</
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
</
|
|
397
|
-
|
|
398
|
-
</div
|
|
843
|
+
</div>
|
|
844
|
+
<div class="tsd-comment tsd-typography">
|
|
845
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
846
|
+
</code><button>Copy</button></pre>
|
|
847
|
+
</div><aside class="tsd-sources">
|
|
848
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.github</p></aside></section>
|
|
849
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="githubOptions" class="tsd-anchor"></a>
|
|
850
|
+
<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>
|
|
851
|
+
<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>
|
|
852
|
+
<div class="tsd-comment tsd-typography"><p>Options for GitHub integration</p>
|
|
853
|
+
</div>
|
|
854
|
+
<div class="tsd-comment tsd-typography">
|
|
855
|
+
<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>
|
|
856
|
+
</code><button>Copy</button></pre>
|
|
857
|
+
</div><aside class="tsd-sources">
|
|
858
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.githubOptions</p></aside></section>
|
|
859
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitignore" class="tsd-anchor"></a>
|
|
860
|
+
<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>
|
|
861
|
+
<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>
|
|
862
|
+
<div class="tsd-comment tsd-typography"><p>Additional entries to .gitignore</p>
|
|
863
|
+
</div>
|
|
864
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
865
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitignore</p></aside></section>
|
|
866
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="gitpod" class="tsd-anchor"></a>
|
|
867
|
+
<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>
|
|
868
|
+
<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>
|
|
869
|
+
<div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment</p>
|
|
870
|
+
</div>
|
|
871
|
+
<div class="tsd-comment tsd-typography">
|
|
872
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
873
|
+
</code><button>Copy</button></pre>
|
|
874
|
+
</div><aside class="tsd-sources">
|
|
875
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitpod</p></aside></section>
|
|
876
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="homepage" 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>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>
|
|
878
|
+
<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>
|
|
879
|
+
<div class="tsd-comment tsd-typography"><p>Package's Homepage / Website</p>
|
|
880
|
+
</div>
|
|
881
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
882
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.homepage</p></aside></section>
|
|
883
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="integrationTestAutoDiscover" class="tsd-anchor"></a>
|
|
884
|
+
<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>
|
|
885
|
+
<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>
|
|
886
|
+
<div class="tsd-comment tsd-typography"><p>Automatically discovers and creates integration tests for each <code>.integ.ts</code>
|
|
399
887
|
file in under your test directory.</p>
|
|
400
|
-
</div
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
</
|
|
404
|
-
</
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
</code
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
</
|
|
411
|
-
|
|
412
|
-
|
|
888
|
+
</div>
|
|
889
|
+
<div class="tsd-comment tsd-typography">
|
|
890
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
891
|
+
</code><button>Copy</button></pre>
|
|
892
|
+
</div><aside class="tsd-sources">
|
|
893
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.integrationTestAutoDiscover</p></aside></section>
|
|
894
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jest" class="tsd-anchor"></a>
|
|
895
|
+
<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>
|
|
896
|
+
<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>
|
|
897
|
+
<div class="tsd-comment tsd-typography"><p>Setup jest unit tests</p>
|
|
898
|
+
</div>
|
|
899
|
+
<div class="tsd-comment tsd-typography">
|
|
900
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
901
|
+
</code><button>Copy</button></pre>
|
|
902
|
+
</div><aside class="tsd-sources">
|
|
903
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jest</p></aside></section>
|
|
904
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jestOptions" class="tsd-anchor"></a>
|
|
905
|
+
<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>
|
|
906
|
+
<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>
|
|
907
|
+
<div class="tsd-comment tsd-typography"><p>Jest options</p>
|
|
908
|
+
</div>
|
|
909
|
+
<div class="tsd-comment tsd-typography">
|
|
910
|
+
<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>
|
|
911
|
+
</code><button>Copy</button></pre>
|
|
912
|
+
</div><aside class="tsd-sources">
|
|
913
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jestOptions</p></aside></section>
|
|
914
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="jsiiReleaseVersion" class="tsd-anchor"></a>
|
|
915
|
+
<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>
|
|
916
|
+
<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>
|
|
917
|
+
<div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
918
|
+
</div>
|
|
919
|
+
<div class="tsd-comment tsd-typography">
|
|
920
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"latest"</span>
|
|
921
|
+
</code><button>Copy</button></pre>
|
|
922
|
+
</div><aside class="tsd-sources">
|
|
923
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jsiiReleaseVersion</p></aside></section>
|
|
924
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keywords" class="tsd-anchor"></a>
|
|
925
|
+
<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>
|
|
926
|
+
<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>
|
|
927
|
+
<div class="tsd-comment tsd-typography"><p>Keywords to include in <code>package.json</code>.</p>
|
|
928
|
+
</div>
|
|
929
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
930
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.keywords</p></aside></section>
|
|
931
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaAutoDiscover" class="tsd-anchor"></a>
|
|
932
|
+
<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>
|
|
933
|
+
<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>
|
|
934
|
+
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaFunction</code> for each <code>.lambda.ts</code> handler
|
|
413
935
|
in your source tree. If this is disabled, you can manually add an
|
|
414
936
|
<code>awscdk.AutoDiscover</code> component to your project.</p>
|
|
415
|
-
</div
|
|
416
|
-
|
|
417
|
-
|
|
937
|
+
</div>
|
|
938
|
+
<div class="tsd-comment tsd-typography">
|
|
939
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
940
|
+
</code><button>Copy</button></pre>
|
|
941
|
+
</div><aside class="tsd-sources">
|
|
942
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaAutoDiscover</p></aside></section>
|
|
943
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaExtensionAutoDiscover" class="tsd-anchor"></a>
|
|
944
|
+
<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>
|
|
945
|
+
<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>
|
|
946
|
+
<div class="tsd-comment tsd-typography"><p>Automatically adds an <code>awscdk.LambdaExtension</code> for each <code>.lambda-extension.ts</code>
|
|
418
947
|
entrypoint in your source tree. If this is disabled, you can manually add an
|
|
419
948
|
<code>awscdk.AutoDiscover</code> component to your project</p>
|
|
420
|
-
</div
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
</
|
|
424
|
-
</
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
</code
|
|
428
|
-
|
|
949
|
+
</div>
|
|
950
|
+
<div class="tsd-comment tsd-typography">
|
|
951
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
952
|
+
</code><button>Copy</button></pre>
|
|
953
|
+
</div><aside class="tsd-sources">
|
|
954
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaExtensionAutoDiscover</p></aside></section>
|
|
955
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lambdaOptions" class="tsd-anchor"></a>
|
|
956
|
+
<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>
|
|
957
|
+
<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>
|
|
958
|
+
<div class="tsd-comment tsd-typography"><p>Common options for all AWS Lambda functions.</p>
|
|
959
|
+
</div>
|
|
960
|
+
<div class="tsd-comment tsd-typography">
|
|
961
|
+
<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>
|
|
962
|
+
</code><button>Copy</button></pre>
|
|
963
|
+
</div><aside class="tsd-sources">
|
|
964
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaOptions</p></aside></section>
|
|
965
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="libdir" class="tsd-anchor"></a>
|
|
966
|
+
<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>
|
|
967
|
+
<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>
|
|
968
|
+
<div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory</p>
|
|
969
|
+
</div>
|
|
970
|
+
<div class="tsd-comment tsd-typography">
|
|
971
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"lib"</span>
|
|
972
|
+
</code><button>Copy</button></pre>
|
|
973
|
+
</div><aside class="tsd-sources">
|
|
974
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.libdir</p></aside></section>
|
|
975
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="license" class="tsd-anchor"></a>
|
|
976
|
+
<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>
|
|
977
|
+
<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>
|
|
978
|
+
<div class="tsd-comment tsd-typography"><p>License's SPDX identifier.
|
|
429
979
|
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.
|
|
430
980
|
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
431
|
-
</div
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
</
|
|
435
|
-
</
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
</code
|
|
439
|
-
|
|
981
|
+
</div>
|
|
982
|
+
<div class="tsd-comment tsd-typography">
|
|
983
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"Apache-2.0"</span>
|
|
984
|
+
</code><button>Copy</button></pre>
|
|
985
|
+
</div><aside class="tsd-sources">
|
|
986
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.license</p></aside></section>
|
|
987
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="licensed" class="tsd-anchor"></a>
|
|
988
|
+
<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>
|
|
989
|
+
<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>
|
|
990
|
+
<div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
991
|
+
</div>
|
|
992
|
+
<div class="tsd-comment tsd-typography">
|
|
993
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
994
|
+
</code><button>Copy</button></pre>
|
|
995
|
+
</div><aside class="tsd-sources">
|
|
996
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.licensed</p></aside></section>
|
|
997
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logging" class="tsd-anchor"></a>
|
|
998
|
+
<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>
|
|
999
|
+
<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>
|
|
1000
|
+
<div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
1001
|
+
</div>
|
|
1002
|
+
<div class="tsd-comment tsd-typography">
|
|
1003
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">{}</span>
|
|
1004
|
+
</code><button>Copy</button></pre>
|
|
1005
|
+
</div><aside class="tsd-sources">
|
|
1006
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.logging</p></aside></section>
|
|
1007
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="majorVersion" class="tsd-anchor"></a>
|
|
1008
|
+
<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>
|
|
1009
|
+
<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>
|
|
1010
|
+
<div class="tsd-comment tsd-typography"><p>Major version to release from the default branch.</p>
|
|
440
1011
|
<p>If this is specified, we bump the latest version of this major version line.
|
|
441
1012
|
If not specified, we bump the global latest version.</p>
|
|
442
|
-
</div
|
|
443
|
-
|
|
444
|
-
</
|
|
445
|
-
</
|
|
446
|
-
</
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
</code
|
|
1013
|
+
</div>
|
|
1014
|
+
<div class="tsd-comment tsd-typography">
|
|
1015
|
+
<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>
|
|
1016
|
+
</code><button>Copy</button></pre>
|
|
1017
|
+
</div><aside class="tsd-sources">
|
|
1018
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.majorVersion</p></aside></section>
|
|
1019
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" 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>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>
|
|
1021
|
+
<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>
|
|
1022
|
+
<div class="tsd-comment tsd-typography"><p>Minimum node.js version to require via <code>engines</code> (inclusive).</p>
|
|
1023
|
+
</div>
|
|
1024
|
+
<div class="tsd-comment tsd-typography">
|
|
1025
|
+
<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>
|
|
1026
|
+
</code><button>Copy</button></pre>
|
|
1027
|
+
</div><aside class="tsd-sources">
|
|
1028
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.maxNodeVersion</p></aside></section>
|
|
1029
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergify" class="tsd-anchor"></a>
|
|
1030
|
+
<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>
|
|
1031
|
+
<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>
|
|
1032
|
+
<div class="tsd-comment tsd-typography"><p>Whether mergify should be enabled on this repository or not.</p>
|
|
1033
|
+
</div>
|
|
1034
|
+
<div class="tsd-comment tsd-typography">
|
|
1035
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1036
|
+
</code><button>Copy</button></pre>
|
|
1037
|
+
|
|
450
1038
|
<h4>Deprecated</h4><p>use <code>githubOptions.mergify</code> instead</p>
|
|
451
|
-
</div><aside class="tsd-sources"
|
|
452
|
-
|
|
453
|
-
|
|
1039
|
+
</div><aside class="tsd-sources">
|
|
1040
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergify</p></aside></section>
|
|
1041
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mergifyOptions" class="tsd-anchor"></a>
|
|
1042
|
+
<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>
|
|
1043
|
+
<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>
|
|
1044
|
+
<div class="tsd-comment tsd-typography"><p>Options for mergify</p>
|
|
1045
|
+
</div>
|
|
1046
|
+
<div class="tsd-comment tsd-typography">
|
|
1047
|
+
<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>
|
|
1048
|
+
</code><button>Copy</button></pre>
|
|
1049
|
+
|
|
454
1050
|
<h4>Deprecated</h4><p>use <code>githubOptions.mergifyOptions</code> instead</p>
|
|
455
|
-
</div><aside class="tsd-sources"
|
|
1051
|
+
</div><aside class="tsd-sources">
|
|
1052
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mergifyOptions</p></aside></section>
|
|
1053
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minMajorVersion" class="tsd-anchor"></a>
|
|
1054
|
+
<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>
|
|
1055
|
+
<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>
|
|
1056
|
+
<div class="tsd-comment tsd-typography"><p>Minimal Major version to release</p>
|
|
456
1057
|
<p>This can be useful to set to 1, as breaking changes before the 1.x major
|
|
457
1058
|
release are not incrementing the major version number.</p>
|
|
458
1059
|
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
459
|
-
</div
|
|
460
|
-
|
|
461
|
-
</
|
|
462
|
-
</
|
|
463
|
-
</
|
|
464
|
-
|
|
1060
|
+
</div>
|
|
1061
|
+
<div class="tsd-comment tsd-typography">
|
|
1062
|
+
<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>
|
|
1063
|
+
</code><button>Copy</button></pre>
|
|
1064
|
+
</div><aside class="tsd-sources">
|
|
1065
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minMajorVersion</p></aside></section>
|
|
1066
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" 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>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>
|
|
1068
|
+
<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>
|
|
1069
|
+
<div class="tsd-comment tsd-typography"><p>Minimum Node.js version to require via package.json <code>engines</code> (inclusive).</p>
|
|
1070
|
+
</div>
|
|
1071
|
+
<div class="tsd-comment tsd-typography">
|
|
1072
|
+
<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>
|
|
1073
|
+
</code><button>Copy</button></pre>
|
|
1074
|
+
</div><aside class="tsd-sources">
|
|
1075
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minNodeVersion</p></aside></section>
|
|
1076
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="mutableBuild" class="tsd-anchor"></a>
|
|
1077
|
+
<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>
|
|
1078
|
+
<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>
|
|
1079
|
+
<div class="tsd-comment tsd-typography"><p>Automatically update files modified during builds to pull-request branches. This means
|
|
465
1080
|
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
466
1081
|
before a PR is merged.</p>
|
|
467
1082
|
<p>Implies that PR builds do not have anti-tamper checks.</p>
|
|
468
|
-
</div
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
</
|
|
472
|
-
</
|
|
473
|
-
<
|
|
474
|
-
|
|
1083
|
+
</div>
|
|
1084
|
+
<div class="tsd-comment tsd-typography">
|
|
1085
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1086
|
+
</code><button>Copy</button></pre>
|
|
1087
|
+
</div><aside class="tsd-sources">
|
|
1088
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.mutableBuild</p></aside></section>
|
|
1089
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="name" class="tsd-anchor"></a>
|
|
1090
|
+
<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>
|
|
1091
|
+
<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>
|
|
1092
|
+
<div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
1093
|
+
</div>
|
|
1094
|
+
<div class="tsd-comment tsd-typography">
|
|
1095
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">$BASEDIR</span>
|
|
1096
|
+
</code><button>Copy</button></pre>
|
|
1097
|
+
|
|
1098
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
1099
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.name</p></aside></section>
|
|
1100
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmAccess" class="tsd-anchor"></a>
|
|
1101
|
+
<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>
|
|
1102
|
+
<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>
|
|
1103
|
+
<div class="tsd-comment tsd-typography"><p>Access level of the npm package.</p>
|
|
1104
|
+
</div>
|
|
1105
|
+
<div class="tsd-comment tsd-typography">
|
|
1106
|
+
<h4>Default</h4><ul>
|
|
475
1107
|
<li>for scoped packages (e.g. <code>foo@bar</code>), the default is
|
|
476
1108
|
<code>NpmAccess.RESTRICTED</code>, for non-scoped packages, the default is
|
|
477
1109
|
<code>NpmAccess.PUBLIC</code>.</li>
|
|
478
1110
|
</ul>
|
|
479
|
-
</div><aside class="tsd-sources"
|
|
1111
|
+
</div><aside class="tsd-sources">
|
|
1112
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmAccess</p></aside></section>
|
|
1113
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmDistTag" class="tsd-anchor"></a>
|
|
1114
|
+
<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>
|
|
1115
|
+
<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>
|
|
1116
|
+
<div class="tsd-comment tsd-typography"><p>The npmDistTag to use when publishing from the default branch.</p>
|
|
480
1117
|
<p>To set the npm dist-tag for release branches, set the <code>npmDistTag</code> property
|
|
481
1118
|
for each branch.</p>
|
|
482
|
-
</div
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
</
|
|
486
|
-
</div><
|
|
487
|
-
|
|
1119
|
+
</div>
|
|
1120
|
+
<div class="tsd-comment tsd-typography">
|
|
1121
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"latest"</span>
|
|
1122
|
+
</code><button>Copy</button></pre>
|
|
1123
|
+
</div><aside class="tsd-sources">
|
|
1124
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmDistTag</p></aside></section>
|
|
1125
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmIgnoreOptions" class="tsd-anchor"></a>
|
|
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/>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>
|
|
1127
|
+
<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>
|
|
1128
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for .npmignore file</p>
|
|
1129
|
+
</div>
|
|
1130
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1131
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmIgnoreOptions</p></aside></section>
|
|
1132
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmRegistry" class="tsd-anchor"></a>
|
|
1133
|
+
<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>
|
|
1134
|
+
<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>
|
|
1135
|
+
<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>
|
|
1136
|
+
</div>
|
|
1137
|
+
<div class="tsd-comment tsd-typography">
|
|
1138
|
+
<h4>Deprecated</h4><p>use <code>npmRegistryUrl</code> instead</p>
|
|
1139
|
+
</div><aside class="tsd-sources">
|
|
1140
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistry</p></aside></section>
|
|
1141
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmRegistryUrl" class="tsd-anchor"></a>
|
|
1142
|
+
<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>
|
|
1143
|
+
<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>
|
|
1144
|
+
<div class="tsd-comment tsd-typography"><p>The base URL of the npm package registry.</p>
|
|
488
1145
|
<p>Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
489
|
-
</div
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
</
|
|
493
|
-
</
|
|
494
|
-
|
|
495
|
-
|
|
1146
|
+
</div>
|
|
1147
|
+
<div class="tsd-comment tsd-typography">
|
|
1148
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"https://registry.npmjs.org"</span>
|
|
1149
|
+
</code><button>Copy</button></pre>
|
|
1150
|
+
</div><aside class="tsd-sources">
|
|
1151
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmRegistryUrl</p></aside></section>
|
|
1152
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmTokenSecret" class="tsd-anchor"></a>
|
|
1153
|
+
<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>
|
|
1154
|
+
<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>
|
|
1155
|
+
<div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
1156
|
+
</div>
|
|
1157
|
+
<div class="tsd-comment tsd-typography">
|
|
1158
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"NPM_TOKEN"</span>
|
|
1159
|
+
</code><button>Copy</button></pre>
|
|
1160
|
+
</div><aside class="tsd-sources">
|
|
1161
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmTokenSecret</p></aside></section>
|
|
1162
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignore" class="tsd-anchor"></a>
|
|
1163
|
+
<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>
|
|
1164
|
+
<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>
|
|
1165
|
+
<div class="tsd-comment tsd-typography"><p>Additional entries to .npmignore.</p>
|
|
1166
|
+
</div>
|
|
1167
|
+
<div class="tsd-comment tsd-typography">
|
|
1168
|
+
<h4>Deprecated</h4><ul>
|
|
496
1169
|
<li>use <code>project.addPackageIgnore</code></li>
|
|
497
1170
|
</ul>
|
|
498
|
-
</div><aside class="tsd-sources"
|
|
1171
|
+
</div><aside class="tsd-sources">
|
|
1172
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignore</p></aside></section>
|
|
1173
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="npmignoreEnabled" class="tsd-anchor"></a>
|
|
1174
|
+
<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>
|
|
1175
|
+
<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>
|
|
1176
|
+
<div class="tsd-comment tsd-typography"><p>Defines an .npmignore file. Normally this is only needed for libraries that
|
|
499
1177
|
are packaged as tarballs.</p>
|
|
500
|
-
</div
|
|
501
|
-
|
|
502
|
-
|
|
1178
|
+
</div>
|
|
1179
|
+
<div class="tsd-comment tsd-typography">
|
|
1180
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1181
|
+
</code><button>Copy</button></pre>
|
|
1182
|
+
</div><aside class="tsd-sources">
|
|
1183
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignoreEnabled</p></aside></section>
|
|
1184
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="outdir" class="tsd-anchor"></a>
|
|
1185
|
+
<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>
|
|
1186
|
+
<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>
|
|
1187
|
+
<div class="tsd-comment tsd-typography"><p>The root directory of the project.</p>
|
|
503
1188
|
<p>Relative to this directory, all files are synthesized.</p>
|
|
504
1189
|
<p>If this project has a parent, this directory is relative to the parent
|
|
505
1190
|
directory and it cannot be the same as the parent or any of it's other
|
|
506
1191
|
subprojects.</p>
|
|
507
|
-
</div
|
|
508
|
-
|
|
509
|
-
|
|
1192
|
+
</div>
|
|
1193
|
+
<div class="tsd-comment tsd-typography">
|
|
1194
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"."</span>
|
|
1195
|
+
</code><button>Copy</button></pre>
|
|
1196
|
+
</div><aside class="tsd-sources">
|
|
1197
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.outdir</p></aside></section>
|
|
1198
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="package" class="tsd-anchor"></a>
|
|
1199
|
+
<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>
|
|
1200
|
+
<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>
|
|
1201
|
+
<div class="tsd-comment tsd-typography"><p>Defines a <code>package</code> task that will produce an npm tarball under the
|
|
510
1202
|
artifacts directory (e.g. <code>dist</code>).</p>
|
|
511
|
-
</div
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
</
|
|
515
|
-
</
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
</code
|
|
519
|
-
<
|
|
520
|
-
|
|
521
|
-
</div
|
|
1203
|
+
</div>
|
|
1204
|
+
<div class="tsd-comment tsd-typography">
|
|
1205
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1206
|
+
</code><button>Copy</button></pre>
|
|
1207
|
+
</div><aside class="tsd-sources">
|
|
1208
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.package</p></aside></section>
|
|
1209
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageManager" class="tsd-anchor"></a>
|
|
1210
|
+
<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>
|
|
1211
|
+
<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>
|
|
1212
|
+
<div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts</p>
|
|
1213
|
+
</div>
|
|
1214
|
+
<div class="tsd-comment tsd-typography">
|
|
1215
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">NodePackageManager</span><span class="hl-1">.</span><span class="hl-6">YARN_CLASSIC</span>
|
|
1216
|
+
</code><button>Copy</button></pre>
|
|
1217
|
+
</div><aside class="tsd-sources">
|
|
1218
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageManager</p></aside></section>
|
|
1219
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="packageName" class="tsd-anchor"></a>
|
|
1220
|
+
<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>
|
|
1221
|
+
<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>
|
|
1222
|
+
<div class="tsd-comment tsd-typography"><p>The "name" in package.json</p>
|
|
1223
|
+
</div>
|
|
1224
|
+
<div class="tsd-comment tsd-typography">
|
|
1225
|
+
<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>
|
|
1226
|
+
</code><button>Copy</button></pre>
|
|
1227
|
+
|
|
1228
|
+
<h4>Featured</h4></div><aside class="tsd-sources">
|
|
1229
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageName</p></aside></section>
|
|
1230
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="parent" class="tsd-anchor"></a>
|
|
1231
|
+
<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>
|
|
1232
|
+
<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>
|
|
1233
|
+
<div class="tsd-comment tsd-typography"><p>The parent project, if this project is part of a bigger project.</p>
|
|
1234
|
+
</div>
|
|
1235
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1236
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.parent</p></aside></section>
|
|
1237
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="peerDependencyOptions" 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>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>
|
|
1239
|
+
<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>
|
|
1240
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>peerDeps</code>.</p>
|
|
1241
|
+
</div>
|
|
1242
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1243
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDependencyOptions</p></aside></section>
|
|
1244
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="peerDeps" class="tsd-anchor"></a>
|
|
1245
|
+
<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>
|
|
1246
|
+
<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>
|
|
1247
|
+
<div class="tsd-comment tsd-typography"><p>Peer dependencies for this module. Dependencies listed here are required to
|
|
522
1248
|
be installed (and satisfied) by the <em>consumer</em> of this library. Using peer
|
|
523
1249
|
dependencies allows you to ensure that only a single module of a certain
|
|
524
1250
|
library exists in the <code>node_modules</code> tree of your consumers.</p>
|
|
@@ -529,240 +1255,914 @@ breaking change for your customers.</p>
|
|
|
529
1255
|
enabled by default), projen will automatically add a dev dependency with a
|
|
530
1256
|
pinned version for each peer dependency. This will ensure that you build &
|
|
531
1257
|
test your module against the lowest peer version required.</p>
|
|
532
|
-
</div
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
</div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"7"</span>
|
|
1258
|
+
</div>
|
|
1259
|
+
<div class="tsd-comment tsd-typography">
|
|
1260
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
536
1261
|
</code><button>Copy</button></pre>
|
|
537
|
-
</div><aside class="tsd-sources"
|
|
538
|
-
|
|
1262
|
+
</div><aside class="tsd-sources">
|
|
1263
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.peerDeps</p></aside></section>
|
|
1264
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pnpmVersion" class="tsd-anchor"></a>
|
|
1265
|
+
<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>
|
|
1266
|
+
<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>
|
|
1267
|
+
<div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
1268
|
+
</div>
|
|
1269
|
+
<div class="tsd-comment tsd-typography">
|
|
1270
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"7"</span>
|
|
1271
|
+
</code><button>Copy</button></pre>
|
|
1272
|
+
</div><aside class="tsd-sources">
|
|
1273
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pnpmVersion</p></aside></section>
|
|
1274
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="postBuildSteps" class="tsd-anchor"></a>
|
|
1275
|
+
<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>
|
|
1276
|
+
<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>
|
|
1277
|
+
<div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
1278
|
+
</div>
|
|
1279
|
+
<div class="tsd-comment tsd-typography">
|
|
1280
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
539
1281
|
</code><button>Copy</button></pre>
|
|
540
|
-
</div><aside class="tsd-sources"
|
|
1282
|
+
</div><aside class="tsd-sources">
|
|
1283
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.postBuildSteps</p></aside></section>
|
|
1284
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prerelease" 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>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>
|
|
1286
|
+
<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>
|
|
1287
|
+
<div class="tsd-comment tsd-typography"><p>Bump versions from the default branch as pre-releases (e.g. "beta",
|
|
541
1288
|
"alpha", "pre").</p>
|
|
542
|
-
</div
|
|
543
|
-
|
|
544
|
-
</
|
|
545
|
-
</
|
|
546
|
-
</
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
</code
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
</
|
|
1289
|
+
</div>
|
|
1290
|
+
<div class="tsd-comment tsd-typography">
|
|
1291
|
+
<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>
|
|
1292
|
+
</code><button>Copy</button></pre>
|
|
1293
|
+
</div><aside class="tsd-sources">
|
|
1294
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prerelease</p></aside></section>
|
|
1295
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettier" 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>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>
|
|
1297
|
+
<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>
|
|
1298
|
+
<div class="tsd-comment tsd-typography"><p>Setup prettier.</p>
|
|
1299
|
+
</div>
|
|
1300
|
+
<div class="tsd-comment tsd-typography">
|
|
1301
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1302
|
+
</code><button>Copy</button></pre>
|
|
1303
|
+
</div><aside class="tsd-sources">
|
|
1304
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettier</p></aside></section>
|
|
1305
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prettierOptions" class="tsd-anchor"></a>
|
|
1306
|
+
<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>
|
|
1307
|
+
<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>
|
|
1308
|
+
<div class="tsd-comment tsd-typography"><p>Prettier options</p>
|
|
1309
|
+
</div>
|
|
1310
|
+
<div class="tsd-comment tsd-typography">
|
|
1311
|
+
<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>
|
|
1312
|
+
</code><button>Copy</button></pre>
|
|
1313
|
+
</div><aside class="tsd-sources">
|
|
1314
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettierOptions</p></aside></section>
|
|
1315
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projectType" class="tsd-anchor"></a>
|
|
1316
|
+
<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>
|
|
1317
|
+
<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>
|
|
1318
|
+
<div class="tsd-comment tsd-typography"><p>Which type of project this is (library/app).</p>
|
|
1319
|
+
</div>
|
|
1320
|
+
<div class="tsd-comment tsd-typography">
|
|
1321
|
+
<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>
|
|
1322
|
+
</code><button>Copy</button></pre>
|
|
1323
|
+
|
|
553
1324
|
<h4>Deprecated</h4><p>no longer supported at the base project level</p>
|
|
554
|
-
</div><aside class="tsd-sources"
|
|
1325
|
+
</div><aside class="tsd-sources">
|
|
1326
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projectType</p></aside></section>
|
|
1327
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCommand" class="tsd-anchor"></a>
|
|
1328
|
+
<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>
|
|
1329
|
+
<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>
|
|
1330
|
+
<div class="tsd-comment tsd-typography"><p>The shell command to use in order to run the projen CLI.</p>
|
|
555
1331
|
<p>Can be used to customize in special environments.</p>
|
|
556
|
-
</div
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
</
|
|
560
|
-
</
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
</code
|
|
564
|
-
|
|
1332
|
+
</div>
|
|
1333
|
+
<div class="tsd-comment tsd-typography">
|
|
1334
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"npx projen"</span>
|
|
1335
|
+
</code><button>Copy</button></pre>
|
|
1336
|
+
</div><aside class="tsd-sources">
|
|
1337
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCommand</p></aside></section>
|
|
1338
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenCredentials" class="tsd-anchor"></a>
|
|
1339
|
+
<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>
|
|
1340
|
+
<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>
|
|
1341
|
+
<div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
1342
|
+
</div>
|
|
1343
|
+
<div class="tsd-comment tsd-typography">
|
|
1344
|
+
<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>
|
|
1345
|
+
</code><button>Copy</button></pre>
|
|
1346
|
+
</div><aside class="tsd-sources">
|
|
1347
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCredentials</p></aside></section>
|
|
1348
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenDevDependency" class="tsd-anchor"></a>
|
|
1349
|
+
<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>
|
|
1350
|
+
<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>
|
|
1351
|
+
<div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
1352
|
+
</div>
|
|
1353
|
+
<div class="tsd-comment tsd-typography">
|
|
1354
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1355
|
+
</code><button>Copy</button></pre>
|
|
1356
|
+
</div><aside class="tsd-sources">
|
|
1357
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenDevDependency</p></aside></section>
|
|
1358
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenTokenSecret" class="tsd-anchor"></a>
|
|
1359
|
+
<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>
|
|
1360
|
+
<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>
|
|
1361
|
+
<div class="tsd-comment tsd-typography"><p>The name of a secret which includes a GitHub Personal Access Token to be
|
|
565
1362
|
used by projen workflows. This token needs to have the <code>repo</code>, <code>workflows</code>
|
|
566
1363
|
and <code>packages</code> scope.</p>
|
|
567
|
-
</div
|
|
1364
|
+
</div>
|
|
1365
|
+
<div class="tsd-comment tsd-typography">
|
|
1366
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"PROJEN_GITHUB_TOKEN"</span>
|
|
568
1367
|
</code><button>Copy</button></pre>
|
|
1368
|
+
|
|
569
1369
|
<h4>Deprecated</h4><p>use <code>projenCredentials</code></p>
|
|
570
|
-
</div><aside class="tsd-sources"
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
1370
|
+
</div><aside class="tsd-sources">
|
|
1371
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenTokenSecret</p></aside></section>
|
|
1372
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenVersion" class="tsd-anchor"></a>
|
|
1373
|
+
<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>
|
|
1374
|
+
<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>
|
|
1375
|
+
<div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
1376
|
+
</div>
|
|
1377
|
+
<div class="tsd-comment tsd-typography">
|
|
1378
|
+
<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>
|
|
1379
|
+
</code><button>Copy</button></pre>
|
|
1380
|
+
</div><aside class="tsd-sources">
|
|
1381
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenVersion</p></aside></section>
|
|
1382
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJs" class="tsd-anchor"></a>
|
|
1383
|
+
<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>
|
|
1384
|
+
<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>
|
|
1385
|
+
<div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.js (in JavaScript). Set to <code>false</code> in order to disable
|
|
574
1386
|
.projenrc.js generation.</p>
|
|
575
|
-
</div
|
|
576
|
-
|
|
577
|
-
</
|
|
578
|
-
</
|
|
579
|
-
</
|
|
580
|
-
|
|
1387
|
+
</div>
|
|
1388
|
+
<div class="tsd-comment tsd-typography">
|
|
1389
|
+
<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>
|
|
1390
|
+
</code><button>Copy</button></pre>
|
|
1391
|
+
</div><aside class="tsd-sources">
|
|
1392
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJs</p></aside></section>
|
|
1393
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsOptions" class="tsd-anchor"></a>
|
|
1394
|
+
<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>
|
|
1395
|
+
<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>
|
|
1396
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.js</p>
|
|
1397
|
+
</div>
|
|
1398
|
+
<div class="tsd-comment tsd-typography">
|
|
1399
|
+
<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>
|
|
1400
|
+
</code><button>Copy</button></pre>
|
|
1401
|
+
</div><aside class="tsd-sources">
|
|
1402
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsOptions</p></aside></section>
|
|
1403
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJson" class="tsd-anchor"></a>
|
|
1404
|
+
<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>
|
|
1405
|
+
<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>
|
|
1406
|
+
<div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.json (in JSON). Set to <code>false</code> in order to disable
|
|
581
1407
|
.projenrc.json generation.</p>
|
|
582
|
-
</div
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
</
|
|
586
|
-
</
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
</code
|
|
1408
|
+
</div>
|
|
1409
|
+
<div class="tsd-comment tsd-typography">
|
|
1410
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1411
|
+
</code><button>Copy</button></pre>
|
|
1412
|
+
</div><aside class="tsd-sources">
|
|
1413
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJson</p></aside></section>
|
|
1414
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcJsonOptions" class="tsd-anchor"></a>
|
|
1415
|
+
<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>
|
|
1416
|
+
<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>
|
|
1417
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.json</p>
|
|
1418
|
+
</div>
|
|
1419
|
+
<div class="tsd-comment tsd-typography">
|
|
1420
|
+
<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>
|
|
1421
|
+
</code><button>Copy</button></pre>
|
|
1422
|
+
</div><aside class="tsd-sources">
|
|
1423
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsonOptions</p></aside></section>
|
|
1424
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTs" class="tsd-anchor"></a>
|
|
1425
|
+
<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>
|
|
1426
|
+
<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>
|
|
1427
|
+
<div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
1428
|
+
</div>
|
|
1429
|
+
<div class="tsd-comment tsd-typography">
|
|
1430
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1431
|
+
</code><button>Copy</button></pre>
|
|
1432
|
+
|
|
590
1433
|
<h4>Pjnew</h4><p>true</p>
|
|
591
|
-
</div><aside class="tsd-sources"
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
</code
|
|
595
|
-
|
|
1434
|
+
</div><aside class="tsd-sources">
|
|
1435
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTs</p></aside></section>
|
|
1436
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="projenrcTsOptions" class="tsd-anchor"></a>
|
|
1437
|
+
<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>
|
|
1438
|
+
<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>
|
|
1439
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.ts</p>
|
|
1440
|
+
</div>
|
|
1441
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1442
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcTsOptions</p></aside></section>
|
|
1443
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishDryRun" class="tsd-anchor"></a>
|
|
1444
|
+
<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>
|
|
1445
|
+
<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>
|
|
1446
|
+
<div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
1447
|
+
</div>
|
|
1448
|
+
<div class="tsd-comment tsd-typography">
|
|
1449
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1450
|
+
</code><button>Copy</button></pre>
|
|
1451
|
+
</div><aside class="tsd-sources">
|
|
1452
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishDryRun</p></aside></section>
|
|
1453
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="publishTasks" class="tsd-anchor"></a>
|
|
1454
|
+
<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>
|
|
1455
|
+
<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>
|
|
1456
|
+
<div class="tsd-comment tsd-typography"><p>Define publishing tasks that can be executed manually as well as workflows.</p>
|
|
596
1457
|
<p>Normally, publishing only happens within automated workflows. Enable this
|
|
597
1458
|
in order to create a publishing task for each publishing activity.</p>
|
|
598
|
-
</div
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
</
|
|
602
|
-
</
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
</code
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
</
|
|
1459
|
+
</div>
|
|
1460
|
+
<div class="tsd-comment tsd-typography">
|
|
1461
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1462
|
+
</code><button>Copy</button></pre>
|
|
1463
|
+
</div><aside class="tsd-sources">
|
|
1464
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishTasks</p></aside></section>
|
|
1465
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplate" class="tsd-anchor"></a>
|
|
1466
|
+
<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>
|
|
1467
|
+
<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>
|
|
1468
|
+
<div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
1469
|
+
</div>
|
|
1470
|
+
<div class="tsd-comment tsd-typography">
|
|
1471
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1472
|
+
</code><button>Copy</button></pre>
|
|
1473
|
+
</div><aside class="tsd-sources">
|
|
1474
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplate</p></aside></section>
|
|
1475
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pullRequestTemplateContents" class="tsd-anchor"></a>
|
|
1476
|
+
<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>
|
|
1477
|
+
<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>
|
|
1478
|
+
<div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
|
|
1479
|
+
</div>
|
|
1480
|
+
<div class="tsd-comment tsd-typography">
|
|
1481
|
+
<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>
|
|
1482
|
+
</code><button>Copy</button></pre>
|
|
1483
|
+
</div><aside class="tsd-sources">
|
|
1484
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplateContents</p></aside></section>
|
|
1485
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readme" class="tsd-anchor"></a>
|
|
1486
|
+
<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>
|
|
1487
|
+
<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>
|
|
1488
|
+
<div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
1489
|
+
</div>
|
|
1490
|
+
<div class="tsd-comment tsd-typography">
|
|
1491
|
+
<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>
|
|
1492
|
+
</code><button>Copy</button></pre>
|
|
1493
|
+
|
|
609
1494
|
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">"{ filename: 'readme.md', contents: '# title' }"</span>
|
|
610
1495
|
</code><button>Copy</button></pre>
|
|
611
|
-
</div><aside class="tsd-sources"
|
|
1496
|
+
</div><aside class="tsd-sources">
|
|
1497
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.readme</p></aside></section>
|
|
1498
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releasableCommits" class="tsd-anchor"></a>
|
|
1499
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>releasable<wbr/>Commits</span><a href="#releasableCommits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1500
|
+
<div class="tsd-signature"><span class="tsd-kind-property">releasable<wbr/>Commits</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ReleasableCommits</span></div>
|
|
1501
|
+
<div class="tsd-comment tsd-typography"><p>Find commits that should be considered releasable
|
|
612
1502
|
Used to decide if a release is required.</p>
|
|
613
|
-
</div
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
</
|
|
617
|
-
</
|
|
618
|
-
|
|
1503
|
+
</div>
|
|
1504
|
+
<div class="tsd-comment tsd-typography">
|
|
1505
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ReleasableCommits</span><span class="hl-1">.</span><span class="hl-0">everyCommit</span><span class="hl-1">()</span>
|
|
1506
|
+
</code><button>Copy</button></pre>
|
|
1507
|
+
</div><aside class="tsd-sources">
|
|
1508
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releasableCommits</p></aside></section>
|
|
1509
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a>
|
|
1510
|
+
<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>
|
|
1511
|
+
<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>
|
|
1512
|
+
<div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
1513
|
+
</div>
|
|
1514
|
+
<div class="tsd-comment tsd-typography">
|
|
1515
|
+
<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>
|
|
1516
|
+
</code><button>Copy</button></pre>
|
|
1517
|
+
</div><aside class="tsd-sources">
|
|
1518
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.release</p></aside></section>
|
|
1519
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseBranches" class="tsd-anchor"></a>
|
|
1520
|
+
<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>
|
|
1521
|
+
<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>
|
|
1522
|
+
<div class="tsd-comment tsd-typography"><p>Defines additional release branches. A workflow will be created for each
|
|
619
1523
|
release branch which will publish releases from commits in this branch.
|
|
620
1524
|
Each release branch <em>must</em> be assigned a major version number which is used
|
|
621
1525
|
to enforce that versions published from that branch always use that major
|
|
622
1526
|
version. If multiple branches are used, the <code>majorVersion</code> field must also
|
|
623
1527
|
be provided for the default branch.</p>
|
|
624
|
-
</div
|
|
1528
|
+
</div>
|
|
1529
|
+
<div class="tsd-type-declaration">
|
|
1530
|
+
<h4>Type declaration</h4>
|
|
1531
|
+
<ul class="tsd-parameters">
|
|
1532
|
+
<li class="tsd-parameter-index-signature">
|
|
1533
|
+
<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>
|
|
1534
|
+
<div class="tsd-comment tsd-typography">
|
|
1535
|
+
<h4>Default</h4><ul>
|
|
625
1536
|
<li>no additional branches are used for release. you can use
|
|
626
1537
|
<code>addBranch()</code> to add additional branches.</li>
|
|
627
1538
|
</ul>
|
|
628
|
-
</div><aside class="tsd-sources"
|
|
629
|
-
|
|
630
|
-
|
|
1539
|
+
</div><aside class="tsd-sources">
|
|
1540
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseBranches</p></aside></section>
|
|
1541
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseEveryCommit" class="tsd-anchor"></a>
|
|
1542
|
+
<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>
|
|
1543
|
+
<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>
|
|
1544
|
+
<div class="tsd-comment tsd-typography"><p>Automatically release new versions every commit to one of branches in <code>releaseBranches</code>.</p>
|
|
1545
|
+
</div>
|
|
1546
|
+
<div class="tsd-comment tsd-typography">
|
|
1547
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1548
|
+
</code><button>Copy</button></pre>
|
|
1549
|
+
|
|
631
1550
|
<h4>Deprecated</h4><p>Use <code>releaseTrigger: ReleaseTrigger.continuous()</code> instead</p>
|
|
632
|
-
</div><aside class="tsd-sources"
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
1551
|
+
</div><aside class="tsd-sources">
|
|
1552
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseEveryCommit</p></aside></section>
|
|
1553
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssue" class="tsd-anchor"></a>
|
|
1554
|
+
<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>
|
|
1555
|
+
<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>
|
|
1556
|
+
<div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
1557
|
+
</div>
|
|
1558
|
+
<div class="tsd-comment tsd-typography">
|
|
1559
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1560
|
+
</code><button>Copy</button></pre>
|
|
1561
|
+
</div><aside class="tsd-sources">
|
|
1562
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssue</p></aside></section>
|
|
1563
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseFailureIssueLabel" class="tsd-anchor"></a>
|
|
1564
|
+
<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>
|
|
1565
|
+
<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>
|
|
1566
|
+
<div class="tsd-comment tsd-typography"><p>The label to apply to issues indicating publish failures.
|
|
636
1567
|
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
637
|
-
</div
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
</
|
|
641
|
-
</
|
|
1568
|
+
</div>
|
|
1569
|
+
<div class="tsd-comment tsd-typography">
|
|
1570
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"failed-release"</span>
|
|
1571
|
+
</code><button>Copy</button></pre>
|
|
1572
|
+
</div><aside class="tsd-sources">
|
|
1573
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssueLabel</p></aside></section>
|
|
1574
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseSchedule" class="tsd-anchor"></a>
|
|
1575
|
+
<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>
|
|
1576
|
+
<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>
|
|
1577
|
+
<div class="tsd-comment tsd-typography"><p>CRON schedule to trigger new releases.</p>
|
|
1578
|
+
</div>
|
|
1579
|
+
<div class="tsd-comment tsd-typography">
|
|
1580
|
+
<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>
|
|
1581
|
+
</code><button>Copy</button></pre>
|
|
1582
|
+
|
|
642
1583
|
<h4>Deprecated</h4><p>Use <code>releaseTrigger: ReleaseTrigger.scheduled()</code> instead</p>
|
|
643
|
-
</div><aside class="tsd-sources"
|
|
1584
|
+
</div><aside class="tsd-sources">
|
|
1585
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseSchedule</p></aside></section>
|
|
1586
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTagPrefix" class="tsd-anchor"></a>
|
|
1587
|
+
<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>
|
|
1588
|
+
<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>
|
|
1589
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add the given prefix to release tags.
|
|
644
1590
|
Useful if you are releasing on multiple branches with overlapping
|
|
645
1591
|
version numbers.</p>
|
|
646
1592
|
<p>Note: this prefix is used to detect the latest tagged version
|
|
647
1593
|
when bumping, so if you change this on a project with an existing version
|
|
648
1594
|
history, you may need to manually tag your latest release
|
|
649
1595
|
with the new prefix.</p>
|
|
650
|
-
</div
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
</
|
|
654
|
-
</
|
|
655
|
-
|
|
656
|
-
|
|
1596
|
+
</div>
|
|
1597
|
+
<div class="tsd-comment tsd-typography">
|
|
1598
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"v"</span>
|
|
1599
|
+
</code><button>Copy</button></pre>
|
|
1600
|
+
</div><aside class="tsd-sources">
|
|
1601
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTagPrefix</p></aside></section>
|
|
1602
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseToNpm" class="tsd-anchor"></a>
|
|
1603
|
+
<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>
|
|
1604
|
+
<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>
|
|
1605
|
+
<div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
1606
|
+
</div>
|
|
1607
|
+
<div class="tsd-comment tsd-typography">
|
|
1608
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1609
|
+
</code><button>Copy</button></pre>
|
|
1610
|
+
</div><aside class="tsd-sources">
|
|
1611
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseToNpm</p></aside></section>
|
|
1612
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseTrigger" class="tsd-anchor"></a>
|
|
1613
|
+
<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>
|
|
1614
|
+
<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>
|
|
1615
|
+
<div class="tsd-comment tsd-typography"><p>The release trigger to use.</p>
|
|
1616
|
+
</div>
|
|
1617
|
+
<div class="tsd-comment tsd-typography">
|
|
1618
|
+
<h4>Default</h4><ul>
|
|
657
1619
|
<li>Continuous releases (<code>ReleaseTrigger.continuous()</code>)</li>
|
|
658
1620
|
</ul>
|
|
659
|
-
</div><aside class="tsd-sources"
|
|
660
|
-
|
|
661
|
-
|
|
1621
|
+
</div><aside class="tsd-sources">
|
|
1622
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseTrigger</p></aside></section>
|
|
1623
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflow" class="tsd-anchor"></a>
|
|
1624
|
+
<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>
|
|
1625
|
+
<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>
|
|
1626
|
+
<div class="tsd-comment tsd-typography"><p>DEPRECATED: renamed to <code>release</code>.</p>
|
|
1627
|
+
</div>
|
|
1628
|
+
<div class="tsd-comment tsd-typography">
|
|
1629
|
+
<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>
|
|
1630
|
+
</code><button>Copy</button></pre>
|
|
1631
|
+
|
|
662
1632
|
<h4>Deprecated</h4><p>see <code>release</code>.</p>
|
|
663
|
-
</div><aside class="tsd-sources"
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
1633
|
+
</div><aside class="tsd-sources">
|
|
1634
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflow</p></aside></section>
|
|
1635
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowName" 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>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>
|
|
1637
|
+
<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>
|
|
1638
|
+
<div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
1639
|
+
</div>
|
|
1640
|
+
<div class="tsd-comment tsd-typography">
|
|
1641
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"Release"</span>
|
|
1642
|
+
</code><button>Copy</button></pre>
|
|
1643
|
+
</div><aside class="tsd-sources">
|
|
1644
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowName</p></aside></section>
|
|
1645
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releaseWorkflowSetupSteps" class="tsd-anchor"></a>
|
|
1646
|
+
<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>
|
|
1647
|
+
<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>
|
|
1648
|
+
<div class="tsd-comment tsd-typography"><p>A set of workflow steps to execute in order to setup the workflow
|
|
667
1649
|
container.</p>
|
|
668
|
-
</div
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
</
|
|
674
|
-
|
|
1650
|
+
</div>
|
|
1651
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1652
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseWorkflowSetupSteps</p></aside></section>
|
|
1653
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebot" class="tsd-anchor"></a>
|
|
1654
|
+
<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>
|
|
1655
|
+
<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>
|
|
1656
|
+
<div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
1657
|
+
</div>
|
|
1658
|
+
<div class="tsd-comment tsd-typography">
|
|
1659
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1660
|
+
</code><button>Copy</button></pre>
|
|
1661
|
+
</div><aside class="tsd-sources">
|
|
1662
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebot</p></aside></section>
|
|
1663
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renovatebotOptions" class="tsd-anchor"></a>
|
|
1664
|
+
<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>
|
|
1665
|
+
<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>
|
|
1666
|
+
<div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
1667
|
+
</div>
|
|
1668
|
+
<div class="tsd-comment tsd-typography">
|
|
1669
|
+
<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>
|
|
1670
|
+
</code><button>Copy</button></pre>
|
|
1671
|
+
</div><aside class="tsd-sources">
|
|
1672
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebotOptions</p></aside></section>
|
|
1673
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repository" class="tsd-anchor"></a>
|
|
1674
|
+
<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>
|
|
1675
|
+
<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>
|
|
1676
|
+
<div class="tsd-comment tsd-typography"><p>The repository is the location where the actual code for your package lives.
|
|
675
1677
|
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>
|
|
676
|
-
</div
|
|
1678
|
+
</div>
|
|
1679
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1680
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repository</p></aside></section>
|
|
1681
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="repositoryDirectory" class="tsd-anchor"></a>
|
|
1682
|
+
<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>
|
|
1683
|
+
<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>
|
|
1684
|
+
<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),
|
|
677
1685
|
you can specify the directory in which it lives.</p>
|
|
678
|
-
</div
|
|
1686
|
+
</div>
|
|
1687
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1688
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.repositoryDirectory</p></aside></section>
|
|
1689
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="requireApproval" class="tsd-anchor"></a>
|
|
1690
|
+
<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>
|
|
1691
|
+
<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>
|
|
1692
|
+
<div class="tsd-comment tsd-typography"><p>To protect you against unintended changes that affect your security posture,
|
|
679
1693
|
the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.</p>
|
|
680
|
-
</div
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
</
|
|
684
|
-
</
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
</code
|
|
688
|
-
|
|
1694
|
+
</div>
|
|
1695
|
+
<div class="tsd-comment tsd-typography">
|
|
1696
|
+
<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>
|
|
1697
|
+
</code><button>Copy</button></pre>
|
|
1698
|
+
</div><aside class="tsd-sources">
|
|
1699
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.requireApproval</p></aside></section>
|
|
1700
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sampleCode" class="tsd-anchor"></a>
|
|
1701
|
+
<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>
|
|
1702
|
+
<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>
|
|
1703
|
+
<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>
|
|
1704
|
+
</div>
|
|
1705
|
+
<div class="tsd-comment tsd-typography">
|
|
1706
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1707
|
+
</code><button>Copy</button></pre>
|
|
1708
|
+
</div><aside class="tsd-sources">
|
|
1709
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.sampleCode</p></aside></section>
|
|
1710
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scopedPackagesOptions" class="tsd-anchor"></a>
|
|
1711
|
+
<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>
|
|
1712
|
+
<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>
|
|
1713
|
+
<div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages</p>
|
|
1714
|
+
</div>
|
|
1715
|
+
<div class="tsd-comment tsd-typography">
|
|
1716
|
+
<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>
|
|
1717
|
+
</code><button>Copy</button></pre>
|
|
1718
|
+
</div><aside class="tsd-sources">
|
|
1719
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scopedPackagesOptions</p></aside></section>
|
|
1720
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="scripts" class="tsd-anchor"></a>
|
|
1721
|
+
<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>
|
|
1722
|
+
<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>
|
|
1723
|
+
<div class="tsd-comment tsd-typography"><p>npm scripts to include. If a script has the same name as a standard script,
|
|
689
1724
|
the standard script will be overwritten.
|
|
690
1725
|
Also adds the script as a task.</p>
|
|
691
|
-
</div
|
|
692
|
-
|
|
1726
|
+
</div>
|
|
1727
|
+
<div class="tsd-type-declaration">
|
|
1728
|
+
<h4>Type declaration</h4>
|
|
1729
|
+
<ul class="tsd-parameters">
|
|
1730
|
+
<li class="tsd-parameter-index-signature">
|
|
1731
|
+
<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>
|
|
1732
|
+
<div class="tsd-comment tsd-typography">
|
|
1733
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">{}</span>
|
|
1734
|
+
</code><button>Copy</button></pre>
|
|
1735
|
+
|
|
693
1736
|
<h4>Deprecated</h4><p>use <code>project.addTask()</code> or <code>package.setScript()</code></p>
|
|
694
|
-
</div><aside class="tsd-sources"
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
</
|
|
701
|
-
|
|
702
|
-
</
|
|
1737
|
+
</div><aside class="tsd-sources">
|
|
1738
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.scripts</p></aside></section>
|
|
1739
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="srcdir" class="tsd-anchor"></a>
|
|
1740
|
+
<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>
|
|
1741
|
+
<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>
|
|
1742
|
+
<div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
1743
|
+
</div>
|
|
1744
|
+
<div class="tsd-comment tsd-typography">
|
|
1745
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"src"</span>
|
|
1746
|
+
</code><button>Copy</button></pre>
|
|
1747
|
+
</div><aside class="tsd-sources">
|
|
1748
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.srcdir</p></aside></section>
|
|
1749
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stability" class="tsd-anchor"></a>
|
|
1750
|
+
<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>
|
|
1751
|
+
<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>
|
|
1752
|
+
<div class="tsd-comment tsd-typography"><p>Package's Stability</p>
|
|
1753
|
+
</div>
|
|
1754
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1755
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stability</p></aside></section>
|
|
1756
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stale" class="tsd-anchor"></a>
|
|
1757
|
+
<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>
|
|
1758
|
+
<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>
|
|
1759
|
+
<div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request. See <code>staleOptions</code> for options.</p>
|
|
1760
|
+
</div>
|
|
1761
|
+
<div class="tsd-comment tsd-typography">
|
|
1762
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1763
|
+
</code><button>Copy</button></pre>
|
|
1764
|
+
</div><aside class="tsd-sources">
|
|
1765
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stale</p></aside></section>
|
|
1766
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="staleOptions" class="tsd-anchor"></a>
|
|
1767
|
+
<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>
|
|
1768
|
+
<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>
|
|
1769
|
+
<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>
|
|
1770
|
+
</div>
|
|
1771
|
+
<div class="tsd-comment tsd-typography">
|
|
1772
|
+
<h4>Default</h4><ul>
|
|
703
1773
|
<li>see defaults in <code>StaleOptions</code></li>
|
|
704
1774
|
</ul>
|
|
705
|
-
</div><aside class="tsd-sources"
|
|
1775
|
+
</div><aside class="tsd-sources">
|
|
1776
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.staleOptions</p></aside></section>
|
|
1777
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="testdir" class="tsd-anchor"></a>
|
|
1778
|
+
<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>
|
|
1779
|
+
<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>
|
|
1780
|
+
<div class="tsd-comment tsd-typography"><p>Jest tests directory. Tests files should be named <code>xxx.test.ts</code>.</p>
|
|
706
1781
|
<p>If this directory is under <code>srcdir</code> (e.g. <code>src/test</code>, <code>src/__tests__</code>),
|
|
707
1782
|
then tests are going to be compiled into <code>lib/</code> and executed as javascript.
|
|
708
1783
|
If the test directory is outside of <code>src</code>, then we configure jest to
|
|
709
1784
|
compile the code in-memory.</p>
|
|
710
|
-
</div
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
</
|
|
714
|
-
</div><
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
</
|
|
719
|
-
|
|
720
|
-
</div
|
|
721
|
-
|
|
722
|
-
|
|
1785
|
+
</div>
|
|
1786
|
+
<div class="tsd-comment tsd-typography">
|
|
1787
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"test"</span>
|
|
1788
|
+
</code><button>Copy</button></pre>
|
|
1789
|
+
</div><aside class="tsd-sources">
|
|
1790
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.testdir</p></aside></section>
|
|
1791
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsJestOptions" class="tsd-anchor"></a>
|
|
1792
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ts<wbr/>Jest<wbr/>Options</span><a href="#tsJestOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1793
|
+
<div class="tsd-signature"><span class="tsd-kind-property">ts<wbr/>Jest<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TsJestOptions</span></div>
|
|
1794
|
+
<div class="tsd-comment tsd-typography"><p>Options for ts-jest</p>
|
|
1795
|
+
</div>
|
|
1796
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1797
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsJestOptions</p></aside></section>
|
|
1798
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfig" class="tsd-anchor"></a>
|
|
1799
|
+
<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>
|
|
1800
|
+
<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>
|
|
1801
|
+
<div class="tsd-comment tsd-typography"><p>Custom TSConfig</p>
|
|
1802
|
+
</div>
|
|
1803
|
+
<div class="tsd-comment tsd-typography">
|
|
1804
|
+
<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>
|
|
1805
|
+
</code><button>Copy</button></pre>
|
|
1806
|
+
</div><aside class="tsd-sources">
|
|
1807
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfig</p></aside></section>
|
|
1808
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDev" class="tsd-anchor"></a>
|
|
1809
|
+
<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>
|
|
1810
|
+
<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>
|
|
1811
|
+
<div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
1812
|
+
</div>
|
|
1813
|
+
<div class="tsd-comment tsd-typography">
|
|
1814
|
+
<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>
|
|
1815
|
+
</code><button>Copy</button></pre>
|
|
1816
|
+
</div><aside class="tsd-sources">
|
|
1817
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDev</p></aside></section>
|
|
1818
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tsconfigDevFile" class="tsd-anchor"></a>
|
|
1819
|
+
<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>
|
|
1820
|
+
<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>
|
|
1821
|
+
<div class="tsd-comment tsd-typography"><p>The name of the development tsconfig.json file.</p>
|
|
1822
|
+
</div>
|
|
1823
|
+
<div class="tsd-comment tsd-typography">
|
|
1824
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"tsconfig.dev.json"</span>
|
|
1825
|
+
</code><button>Copy</button></pre>
|
|
1826
|
+
</div><aside class="tsd-sources">
|
|
1827
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfigDevFile</p></aside></section>
|
|
1828
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="typescriptVersion" class="tsd-anchor"></a>
|
|
1829
|
+
<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>
|
|
1830
|
+
<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>
|
|
1831
|
+
<div class="tsd-comment tsd-typography"><p>TypeScript version to use.</p>
|
|
723
1832
|
<p>NOTE: Typescript is not semantically versioned and should remain on the
|
|
724
1833
|
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
725
|
-
</div
|
|
726
|
-
|
|
727
|
-
|
|
1834
|
+
</div>
|
|
1835
|
+
<div class="tsd-comment tsd-typography">
|
|
1836
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"latest"</span>
|
|
1837
|
+
</code><button>Copy</button></pre>
|
|
1838
|
+
</div><aside class="tsd-sources">
|
|
1839
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.typescriptVersion</p></aside></section>
|
|
1840
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="versionrcOptions" class="tsd-anchor"></a>
|
|
1841
|
+
<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>
|
|
1842
|
+
<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>
|
|
1843
|
+
<div class="tsd-comment tsd-typography"><p>Custom configuration used when creating changelog with standard-version package.
|
|
728
1844
|
Given values either append to default configuration or overwrite values in it.</p>
|
|
729
|
-
</div
|
|
730
|
-
|
|
731
|
-
</
|
|
1845
|
+
</div>
|
|
1846
|
+
<div class="tsd-comment tsd-typography">
|
|
1847
|
+
<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>
|
|
1848
|
+
</code><button>Copy</button></pre>
|
|
1849
|
+
</div><aside class="tsd-sources">
|
|
1850
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.versionrcOptions</p></aside></section>
|
|
1851
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="vscode" class="tsd-anchor"></a>
|
|
1852
|
+
<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>
|
|
1853
|
+
<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>
|
|
1854
|
+
<div class="tsd-comment tsd-typography"><p>Enable VSCode integration.</p>
|
|
732
1855
|
<p>Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
733
|
-
</div
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
</
|
|
737
|
-
</
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
</code
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
</
|
|
744
|
-
|
|
745
|
-
|
|
1856
|
+
</div>
|
|
1857
|
+
<div class="tsd-comment tsd-typography">
|
|
1858
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
1859
|
+
</code><button>Copy</button></pre>
|
|
1860
|
+
</div><aside class="tsd-sources">
|
|
1861
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.vscode</p></aside></section>
|
|
1862
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchExcludes" class="tsd-anchor"></a>
|
|
1863
|
+
<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>
|
|
1864
|
+
<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>
|
|
1865
|
+
<div class="tsd-comment tsd-typography"><p>Glob patterns to exclude from <code>cdk watch</code>.</p>
|
|
1866
|
+
</div>
|
|
1867
|
+
<div class="tsd-comment tsd-typography">
|
|
1868
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
746
1869
|
</code><button>Copy</button></pre>
|
|
747
|
-
</div><aside class="tsd-sources"
|
|
748
|
-
|
|
1870
|
+
</div><aside class="tsd-sources">
|
|
1871
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchExcludes</p></aside></section>
|
|
1872
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="watchIncludes" class="tsd-anchor"></a>
|
|
1873
|
+
<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>
|
|
1874
|
+
<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>
|
|
1875
|
+
<div class="tsd-comment tsd-typography"><p>Glob patterns to include in <code>cdk watch</code>.</p>
|
|
1876
|
+
</div>
|
|
1877
|
+
<div class="tsd-comment tsd-typography">
|
|
1878
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">[]</span>
|
|
749
1879
|
</code><button>Copy</button></pre>
|
|
750
|
-
</div><aside class="tsd-sources"
|
|
751
|
-
|
|
1880
|
+
</div><aside class="tsd-sources">
|
|
1881
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.watchIncludes</p></aside></section>
|
|
1882
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowBootstrapSteps" class="tsd-anchor"></a>
|
|
1883
|
+
<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>
|
|
1884
|
+
<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>
|
|
1885
|
+
<div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
1886
|
+
</div>
|
|
1887
|
+
<div class="tsd-comment tsd-typography">
|
|
1888
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-2">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
1889
|
+
</code><button>Copy</button></pre>
|
|
1890
|
+
</div><aside class="tsd-sources">
|
|
1891
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowBootstrapSteps</p></aside></section>
|
|
1892
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowContainerImage" class="tsd-anchor"></a>
|
|
1893
|
+
<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>
|
|
1894
|
+
<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>
|
|
1895
|
+
<div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
1896
|
+
</div>
|
|
1897
|
+
<div class="tsd-comment tsd-typography">
|
|
1898
|
+
<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>
|
|
1899
|
+
</code><button>Copy</button></pre>
|
|
1900
|
+
</div><aside class="tsd-sources">
|
|
1901
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowContainerImage</p></aside></section>
|
|
1902
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowGitIdentity" class="tsd-anchor"></a>
|
|
1903
|
+
<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>
|
|
1904
|
+
<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>
|
|
1905
|
+
<div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
1906
|
+
</div>
|
|
1907
|
+
<div class="tsd-comment tsd-typography">
|
|
1908
|
+
<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>
|
|
1909
|
+
</code><button>Copy</button></pre>
|
|
1910
|
+
</div><aside class="tsd-sources">
|
|
1911
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowGitIdentity</p></aside></section>
|
|
1912
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowNodeVersion" class="tsd-anchor"></a>
|
|
1913
|
+
<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>
|
|
1914
|
+
<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>
|
|
1915
|
+
<div class="tsd-comment tsd-typography"><p>The node version to use in GitHub workflows.</p>
|
|
1916
|
+
</div>
|
|
1917
|
+
<div class="tsd-comment tsd-typography">
|
|
1918
|
+
<h4>Default</h4><ul>
|
|
752
1919
|
<li>same as <code>minNodeVersion</code></li>
|
|
753
1920
|
</ul>
|
|
754
|
-
</div><aside class="tsd-sources"
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
1921
|
+
</div><aside class="tsd-sources">
|
|
1922
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowNodeVersion</p></aside></section>
|
|
1923
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowPackageCache" class="tsd-anchor"></a>
|
|
1924
|
+
<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>
|
|
1925
|
+
<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>
|
|
1926
|
+
<div class="tsd-comment tsd-typography"><p>Enable Node.js package cache in GitHub workflows.</p>
|
|
1927
|
+
</div>
|
|
1928
|
+
<div class="tsd-comment tsd-typography">
|
|
1929
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
1930
|
+
</code><button>Copy</button></pre>
|
|
1931
|
+
</div><aside class="tsd-sources">
|
|
1932
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowPackageCache</p></aside></section>
|
|
1933
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowRunsOn" class="tsd-anchor"></a>
|
|
1934
|
+
<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>
|
|
1935
|
+
<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>
|
|
1936
|
+
<div class="tsd-comment tsd-typography"><p>Github Runner selection labels</p>
|
|
1937
|
+
</div>
|
|
1938
|
+
<div class="tsd-comment tsd-typography">
|
|
1939
|
+
<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>
|
|
1940
|
+
</code><button>Copy</button></pre>
|
|
1941
|
+
|
|
760
1942
|
<h4>Description</h4><p>Defines a target Runner by labels</p>
|
|
1943
|
+
|
|
761
1944
|
<h4>Throws</h4><p>if both <code>runsOn</code> and <code>runsOnGroup</code> are specified</p>
|
|
762
|
-
</div><aside class="tsd-sources"
|
|
763
|
-
|
|
1945
|
+
</div><aside class="tsd-sources">
|
|
1946
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowRunsOn</p></aside></section>
|
|
1947
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowRunsOnGroup" class="tsd-anchor"></a>
|
|
1948
|
+
<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<wbr/>Group</span><a href="#workflowRunsOnGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1949
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Runs<wbr/>On<wbr/>Group</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">GroupRunnerOptions</span></div>
|
|
1950
|
+
<div class="tsd-comment tsd-typography"><p>Github Runner Group selection options</p>
|
|
1951
|
+
</div>
|
|
1952
|
+
<div class="tsd-comment tsd-typography">
|
|
1953
|
+
<h4>Description</h4><p>Defines a target Runner Group by name and/or labels</p>
|
|
1954
|
+
|
|
764
1955
|
<h4>Throws</h4><p>if both <code>runsOn</code> and <code>runsOnGroup</code> are specified</p>
|
|
765
|
-
</div><aside class="tsd-sources"
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
</div><aside class="tsd-sources"><p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.yarnBerryOptions</p></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><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><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><li><a href="#checkLicenses" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>check<wbr/>Licenses</span></a></li><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><li><a href="#experimentalIntegRunner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>experimental<wbr/>Integ<wbr/>Runner</span></a></li><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><li><a href="#releasableCommits" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a></li><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><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><li><a href="#tsJestOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ts<wbr/>Jest<wbr/>Options</span></a></li><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><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><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><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><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><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><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><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><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><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><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><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><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><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><li><a href="#workflowRunsOnGroup" 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<wbr/>Group</span></a></li><li><a href="#yarnBerryOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>cdk-serverless</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li><a href="../classes/Datastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Datastore</a></li><li><a href="../classes/GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>GraphQlApi</a></li><li><a href="../classes/RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>RestApi</a></li><li><a href="../classes/ServerlessProject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ServerlessProject</a></li><li><a href="../classes/Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Workflow</a></li><li><a href="DatastoreOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DatastoreOptions</a></li><li><a href="GraphQlApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>GraphQlApiOptions</a></li><li><a href="RestApiOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>RestApiOptions</a></li><li><a href="ServerlessProjectOptions.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ServerlessProjectOptions</a></li><li><a href="WorkflowOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>WorkflowOptions</a></li><li><a href="../variables/PACKAGE_NAME.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg>PACKAGE_NAME</a></li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><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><g id="icon-2"><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><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><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><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><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><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><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><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><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><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><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><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><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><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><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><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></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></g><g id="icon-search"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><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></g></svg></body></html>
|
|
1956
|
+
</div><aside class="tsd-sources">
|
|
1957
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowRunsOnGroup</p></aside></section>
|
|
1958
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="yarnBerryOptions" class="tsd-anchor"></a>
|
|
1959
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>yarn<wbr/>Berry<wbr/>Options</span><a href="#yarnBerryOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1960
|
+
<div class="tsd-signature"><span class="tsd-kind-property">yarn<wbr/>Berry<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">YarnBerryOptions</span></div>
|
|
1961
|
+
<div class="tsd-comment tsd-typography"><p>Options for Yarn Berry</p>
|
|
1962
|
+
</div>
|
|
1963
|
+
<div class="tsd-comment tsd-typography">
|
|
1964
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">Yarn</span><span class="hl-1"> </span><span class="hl-4">Berry</span><span class="hl-1"> </span><span class="hl-4">v4</span><span class="hl-1"> </span><span class="hl-5">with</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
|
|
1965
|
+
</code><button>Copy</button></pre>
|
|
1966
|
+
</div><aside class="tsd-sources">
|
|
1967
|
+
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.yarnBerryOptions</p></aside></section></section></div>
|
|
1968
|
+
<div class="col-sidebar">
|
|
1969
|
+
<div class="page-menu">
|
|
1970
|
+
<div class="tsd-navigation settings">
|
|
1971
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1972
|
+
<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>
|
|
1973
|
+
<div class="tsd-accordion-details">
|
|
1974
|
+
<div class="tsd-filter-visibility">
|
|
1975
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1976
|
+
<ul id="tsd-filter-options">
|
|
1977
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
1978
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
1979
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
1980
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
1981
|
+
<div class="tsd-theme-toggle">
|
|
1982
|
+
<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>
|
|
1983
|
+
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1984
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1985
|
+
<div class="tsd-accordion-details">
|
|
1986
|
+
<ul>
|
|
1987
|
+
<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>
|
|
1988
|
+
<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>
|
|
1989
|
+
<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>
|
|
1990
|
+
<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>
|
|
1991
|
+
<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>
|
|
1992
|
+
<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>
|
|
1993
|
+
<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>
|
|
1994
|
+
<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>
|
|
1995
|
+
<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>
|
|
1996
|
+
<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>
|
|
1997
|
+
<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>
|
|
1998
|
+
<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>
|
|
1999
|
+
<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>
|
|
2000
|
+
<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>
|
|
2001
|
+
<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>
|
|
2002
|
+
<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>
|
|
2003
|
+
<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>
|
|
2004
|
+
<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>
|
|
2005
|
+
<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>
|
|
2006
|
+
<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>
|
|
2007
|
+
<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>
|
|
2008
|
+
<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>
|
|
2009
|
+
<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>
|
|
2010
|
+
<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>
|
|
2011
|
+
<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>
|
|
2012
|
+
<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>
|
|
2013
|
+
<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>
|
|
2014
|
+
<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>
|
|
2015
|
+
<li><a href="#checkLicenses" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>check<wbr/>Licenses</span></a></li>
|
|
2016
|
+
<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>
|
|
2017
|
+
<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>
|
|
2018
|
+
<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>
|
|
2019
|
+
<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>
|
|
2020
|
+
<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>
|
|
2021
|
+
<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>
|
|
2022
|
+
<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>
|
|
2023
|
+
<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>
|
|
2024
|
+
<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>
|
|
2025
|
+
<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>
|
|
2026
|
+
<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>
|
|
2027
|
+
<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>
|
|
2028
|
+
<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>
|
|
2029
|
+
<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>
|
|
2030
|
+
<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>
|
|
2031
|
+
<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>
|
|
2032
|
+
<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>
|
|
2033
|
+
<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>
|
|
2034
|
+
<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>
|
|
2035
|
+
<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>
|
|
2036
|
+
<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>
|
|
2037
|
+
<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>
|
|
2038
|
+
<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>
|
|
2039
|
+
<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>
|
|
2040
|
+
<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>
|
|
2041
|
+
<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>
|
|
2042
|
+
<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>
|
|
2043
|
+
<li><a href="#experimentalIntegRunner" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>experimental<wbr/>Integ<wbr/>Runner</span></a></li>
|
|
2044
|
+
<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>
|
|
2045
|
+
<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>
|
|
2046
|
+
<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>
|
|
2047
|
+
<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>
|
|
2048
|
+
<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>
|
|
2049
|
+
<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>
|
|
2050
|
+
<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>
|
|
2051
|
+
<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>
|
|
2052
|
+
<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>
|
|
2053
|
+
<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>
|
|
2054
|
+
<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>
|
|
2055
|
+
<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>
|
|
2056
|
+
<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>
|
|
2057
|
+
<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>
|
|
2058
|
+
<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>
|
|
2059
|
+
<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>
|
|
2060
|
+
<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>
|
|
2061
|
+
<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>
|
|
2062
|
+
<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>
|
|
2063
|
+
<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>
|
|
2064
|
+
<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>
|
|
2065
|
+
<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>
|
|
2066
|
+
<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>
|
|
2067
|
+
<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>
|
|
2068
|
+
<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>
|
|
2069
|
+
<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>
|
|
2070
|
+
<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>
|
|
2071
|
+
<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>
|
|
2072
|
+
<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>
|
|
2073
|
+
<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>
|
|
2074
|
+
<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>
|
|
2075
|
+
<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>
|
|
2076
|
+
<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>
|
|
2077
|
+
<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>
|
|
2078
|
+
<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>
|
|
2079
|
+
<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>
|
|
2080
|
+
<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>
|
|
2081
|
+
<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>
|
|
2082
|
+
<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>
|
|
2083
|
+
<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>
|
|
2084
|
+
<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>
|
|
2085
|
+
<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>
|
|
2086
|
+
<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>
|
|
2087
|
+
<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>
|
|
2088
|
+
<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>
|
|
2089
|
+
<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>
|
|
2090
|
+
<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>
|
|
2091
|
+
<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>
|
|
2092
|
+
<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>
|
|
2093
|
+
<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>
|
|
2094
|
+
<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>
|
|
2095
|
+
<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>
|
|
2096
|
+
<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>
|
|
2097
|
+
<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>
|
|
2098
|
+
<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>
|
|
2099
|
+
<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>
|
|
2100
|
+
<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>
|
|
2101
|
+
<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>
|
|
2102
|
+
<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>
|
|
2103
|
+
<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>
|
|
2104
|
+
<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>
|
|
2105
|
+
<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>
|
|
2106
|
+
<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>
|
|
2107
|
+
<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>
|
|
2108
|
+
<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>
|
|
2109
|
+
<li><a href="#releasableCommits" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a></li>
|
|
2110
|
+
<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>
|
|
2111
|
+
<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>
|
|
2112
|
+
<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>
|
|
2113
|
+
<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>
|
|
2114
|
+
<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>
|
|
2115
|
+
<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>
|
|
2116
|
+
<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>
|
|
2117
|
+
<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>
|
|
2118
|
+
<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>
|
|
2119
|
+
<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>
|
|
2120
|
+
<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>
|
|
2121
|
+
<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>
|
|
2122
|
+
<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>
|
|
2123
|
+
<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>
|
|
2124
|
+
<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>
|
|
2125
|
+
<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>
|
|
2126
|
+
<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>
|
|
2127
|
+
<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>
|
|
2128
|
+
<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>
|
|
2129
|
+
<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>
|
|
2130
|
+
<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>
|
|
2131
|
+
<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>
|
|
2132
|
+
<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>
|
|
2133
|
+
<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>
|
|
2134
|
+
<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>
|
|
2135
|
+
<li><a href="#tsJestOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>ts<wbr/>Jest<wbr/>Options</span></a></li>
|
|
2136
|
+
<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>
|
|
2137
|
+
<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>
|
|
2138
|
+
<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>
|
|
2139
|
+
<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>
|
|
2140
|
+
<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>
|
|
2141
|
+
<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>
|
|
2142
|
+
<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>
|
|
2143
|
+
<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>
|
|
2144
|
+
<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>
|
|
2145
|
+
<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>
|
|
2146
|
+
<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>
|
|
2147
|
+
<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>
|
|
2148
|
+
<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>
|
|
2149
|
+
<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>
|
|
2150
|
+
<li><a href="#workflowRunsOnGroup" 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<wbr/>Group</span></a></li>
|
|
2151
|
+
<li><a href="#yarnBerryOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options</span></a></li></ul></div></details></div>
|
|
2152
|
+
<div class="site-menu">
|
|
2153
|
+
<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>
|
|
2154
|
+
<ul class="tsd-small-nested-navigation">
|
|
2155
|
+
<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>
|
|
2156
|
+
<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>
|
|
2157
|
+
<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>
|
|
2158
|
+
<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>
|
|
2159
|
+
<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>
|
|
2160
|
+
<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>
|
|
2161
|
+
<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>
|
|
2162
|
+
<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>
|
|
2163
|
+
<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>
|
|
2164
|
+
<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>
|
|
2165
|
+
<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>
|
|
2166
|
+
<div class="tsd-generator">
|
|
2167
|
+
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
|
|
2168
|
+
<div class="overlay"></div></body></html>
|