cdk-serverless 3.3.2 → 3.4.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/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-233633-review.md +98 -0
- package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-234937-review.md +86 -0
- package/.agents/tasks/task-dependency-cve-upgrade/context.json +24 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-001.json +28 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-002.json +33 -0
- package/.agents/tasks/task-dependency-cve-upgrade/task.json +7 -0
- package/docs/constructs/assets/hierarchy.js +1 -1
- package/docs/constructs/assets/highlight.css +1 -1
- package/docs/constructs/assets/main.js +1 -1
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +18 -3
- package/docs/constructs/classes/AssetCdn.html +161 -20
- package/docs/constructs/classes/BaseApi.html +153 -13
- package/docs/constructs/classes/CognitoAuthentication.html +188 -22
- package/docs/constructs/classes/GraphQlApi.html +349 -23
- package/docs/constructs/classes/LambdaFunction.html +1074 -106
- package/docs/constructs/classes/McpAuth.html +152 -16
- package/docs/constructs/classes/McpCognitoAuth.html +152 -16
- package/docs/constructs/classes/RestApi.html +344 -37
- package/docs/constructs/classes/SingleTableDatastore.html +173 -19
- package/docs/constructs/classes/Workflow.html +170 -21
- package/docs/constructs/hierarchy.html +47 -1
- package/docs/constructs/index.html +75 -2
- package/docs/constructs/interfaces/AssetCdnProps.html +61 -5
- package/docs/constructs/interfaces/BaseApiProps.html +141 -20
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +135 -20
- package/docs/constructs/interfaces/GraphQlApiProps.html +185 -22
- package/docs/constructs/interfaces/ICognitoAuthentication.html +57 -3
- package/docs/constructs/interfaces/IJwtAuthentication.html +63 -5
- package/docs/constructs/interfaces/ISingleTableDatastore.html +57 -3
- package/docs/constructs/interfaces/JsResolverOptions.html +66 -6
- package/docs/constructs/interfaces/LambdaFunctionProps.html +126 -18
- package/docs/constructs/interfaces/LambdaTracingOptions.html +57 -4
- package/docs/constructs/interfaces/McpAuthCognitoOptions.html +75 -8
- package/docs/constructs/interfaces/McpAuthFunctions.html +76 -8
- package/docs/constructs/interfaces/McpAuthGenericOptions.html +66 -6
- package/docs/constructs/interfaces/McpAuthOptions.html +107 -15
- package/docs/constructs/interfaces/McpAuthProps.html +123 -18
- package/docs/constructs/interfaces/McpCognitoAuthProps.html +127 -19
- package/docs/constructs/interfaces/RestApiProps.html +237 -37
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +77 -9
- package/docs/constructs/interfaces/SingleTableDesign.html +72 -7
- package/docs/constructs/interfaces/VtlResolverOptions.html +62 -5
- package/docs/constructs/interfaces/WorkflowProps.html +63 -2
- package/docs/constructs/modules.html +44 -1
- package/docs/constructs/types/LambdaOptions.html +31 -1
- package/docs/experiments/appsync-unit-resolver-error-probe.md +201 -0
- package/docs/lambda/assets/hierarchy.js +1 -1
- package/docs/lambda/assets/highlight.css +1 -1
- package/docs/lambda/assets/main.js +1 -1
- package/docs/lambda/assets/navigation.js +1 -1
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +18 -3
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +247 -20
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +246 -20
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +242 -21
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +235 -20
- package/docs/lambda/classes/auth.JwtAuthorizer.html +225 -20
- package/docs/lambda/classes/errors.BadRequestError.html +147 -11
- package/docs/lambda/classes/errors.ForbiddenError.html +147 -11
- package/docs/lambda/classes/errors.HttpError.html +154 -12
- package/docs/lambda/classes/errors.NotFoundError.html +147 -11
- package/docs/lambda/classes/errors.UnauthenticatedError.html +147 -11
- package/docs/lambda/classes/errors.appsync.AppSyncError.html +193 -0
- package/docs/lambda/classes/errors.appsync.ConflictError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ForbiddenError.html +184 -0
- package/docs/lambda/classes/errors.appsync.NotFoundError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ValidationError.html +184 -0
- package/docs/lambda/functions/api.createAppSyncHandler.html +50 -3
- package/docs/lambda/functions/api.createHttpHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +47 -2
- package/docs/lambda/hierarchy.html +59 -1
- package/docs/lambda/index.html +75 -2
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +68 -3
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +67 -3
- package/docs/lambda/interfaces/api.HttpResponseContext.html +61 -3
- package/docs/lambda/interfaces/api.Operation.html +61 -3
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +65 -3
- package/docs/lambda/modules/api.html +45 -1
- package/docs/lambda/modules/auth.html +37 -1
- package/docs/lambda/modules/errors.appsync.html +38 -0
- package/docs/lambda/modules/errors.html +41 -1
- package/docs/lambda/modules.html +36 -1
- package/docs/lambda/types/api.APIGatewayv1Handler.html +34 -2
- package/docs/lambda/types/api.AppSyncHandler.html +51 -2
- package/docs/lambda/types/api.HttpHandler.html +52 -2
- package/docs/projen/assets/highlight.css +5 -12
- package/docs/projen/assets/main.js +1 -1
- package/docs/projen/assets/style.css +18 -3
- package/docs/projen/classes/Datastore.html +254 -18
- package/docs/projen/classes/GraphQlApi.html +238 -18
- package/docs/projen/classes/RestApi.html +325 -40
- package/docs/projen/classes/ServerlessProject.html +1021 -159
- package/docs/projen/classes/Workflow.html +288 -31
- package/docs/projen/hierarchy.html +29 -1
- package/docs/projen/index.html +75 -2
- package/docs/projen/interfaces/DatastoreOptions.html +54 -2
- package/docs/projen/interfaces/GraphQlApiOptions.html +54 -2
- package/docs/projen/interfaces/RestApiOptions.html +54 -2
- package/docs/projen/interfaces/ServerlessProjectOptions.html +2089 -692
- package/docs/projen/interfaces/WorkflowOptions.html +54 -2
- package/docs/projen/modules.html +44 -1
- package/docs/projen/variables/PACKAGE_NAME.html +31 -1
- package/lib/constructs/graphql.d.ts +17 -0
- package/lib/constructs/graphql.js +78 -2
- package/lib/lambda/appsync-errors.d.ts +67 -0
- package/lib/lambda/appsync-errors.js +91 -0
- package/lib/lambda/errors.d.ts +1 -0
- package/lib/lambda/errors.js +36 -2
- package/lib/lambda/handler.js +78 -1
- package/llm.md +31 -0
- package/package.json +26 -24
|
@@ -1,15 +1,53 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Workflow | 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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Workflow | 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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">Workflow</a></li></ul>
|
|
12
|
+
<h1>Class Workflow</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>The Workflow construct sets up an AWS Step Functions workflow for a serverless project using projen.
|
|
2
15
|
This construct extends the projen Component to generate a sample state machine definition file and corresponding TypeScript construct file.</p>
|
|
3
|
-
</div
|
|
16
|
+
</div>
|
|
17
|
+
<div class="tsd-comment tsd-typography">
|
|
18
|
+
<div class="tsd-tag-example">
|
|
19
|
+
<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">workflow</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Workflow</span><span class="hl-1">(</span><span class="hl-4">app</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">workflowName:</span><span class="hl-1"> </span><span class="hl-2">'MyWorkflow'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">definitionFile:</span><span class="hl-1"> </span><span class="hl-2">'statemachine/definition.json'</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
4
20
|
</code><button type="button">Copy</button></pre>
|
|
5
21
|
|
|
6
|
-
</div></div></section
|
|
7
|
-
|
|
22
|
+
</div></div></section>
|
|
23
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="479">
|
|
24
|
+
<h4>Hierarchy</h4>
|
|
25
|
+
<ul class="tsd-hierarchy">
|
|
26
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">Component</span>
|
|
27
|
+
<ul class="tsd-hierarchy">
|
|
28
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Workflow</span></li></ul></li></ul></section>
|
|
29
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
30
|
+
<section class="tsd-panel tsd-index-panel">
|
|
31
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
32
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
33
|
+
<div class="tsd-accordion-details">
|
|
34
|
+
<section class="tsd-index-section">
|
|
35
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
37
|
+
</div></section>
|
|
38
|
+
<section class="tsd-index-section">
|
|
39
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
40
|
+
<div class="tsd-index-list"><a href="#node" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a>
|
|
8
41
|
<a href="#options" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
|
|
9
42
|
<a href="#project" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project</span></a>
|
|
10
|
-
</div></section
|
|
43
|
+
</div></section>
|
|
44
|
+
<section class="tsd-index-section">
|
|
45
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
46
|
+
<div class="tsd-index-list"><a href="#createconstructfile" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Construct<wbr/>File</span></a>
|
|
47
|
+
<a href="#postprojectcreation" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Project<wbr/>Creation</span></a>
|
|
11
48
|
<a href="#postsynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a>
|
|
12
49
|
<a href="#presynthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a>
|
|
50
|
+
<a href="#projectcreation" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>project<wbr/>Creation</span></a>
|
|
13
51
|
<a href="#renderdefinitionsubstitution" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>Definition<wbr/>Substitution</span></a>
|
|
14
52
|
<a href="#renderstateconfigdefinition" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span></a>
|
|
15
53
|
<a href="#synthesize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>synthesize</span></a>
|
|
@@ -17,33 +55,218 @@ This construct extends the projen Component to generate a sample state machine d
|
|
|
17
55
|
<a href="#with" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a>
|
|
18
56
|
<a href="#iscomponent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Component</span></a>
|
|
19
57
|
<a href="#isconstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
|
20
|
-
</div></section></div></details></section></section
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
</div
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</div
|
|
38
|
-
|
|
58
|
+
</div></section></div></details></section></section>
|
|
59
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
60
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
61
|
+
<section>
|
|
62
|
+
<section class="tsd-panel tsd-member">
|
|
63
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
64
|
+
<ul class="tsd-signatures">
|
|
65
|
+
<li class="">
|
|
66
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorworkflow"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Workflow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">app</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AwsCdkTypeScriptApp</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkflowOptions.html" class="tsd-signature-type tsd-kind-interface">WorkflowOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Workflow</a><a href="#constructorworkflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
67
|
+
<div class="tsd-description">
|
|
68
|
+
<div class="tsd-comment tsd-typography"><p>Creates an instance of Workflow.</p>
|
|
69
|
+
</div>
|
|
70
|
+
<div class="tsd-parameters">
|
|
71
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
72
|
+
<ul class="tsd-parameter-list">
|
|
73
|
+
<li><span><span class="tsd-kind-parameter">app</span>: <span class="tsd-signature-type">AwsCdkTypeScriptApp</span></span>
|
|
74
|
+
<div class="tsd-comment tsd-typography"><p>The AWS CDK TypeScript app.</p>
|
|
75
|
+
</div></li>
|
|
76
|
+
<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/WorkflowOptions.html" class="tsd-signature-type tsd-kind-interface">WorkflowOptions</a></span>
|
|
77
|
+
<div class="tsd-comment tsd-typography"><p>The options for configuring the Workflow.</p>
|
|
78
|
+
</div></li></ul></div>
|
|
79
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Workflow</a></h4><aside class="tsd-sources">
|
|
80
|
+
<p>Overrides pj.Component.constructor</p></aside></div></li></ul></section></section></details>
|
|
81
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
82
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
83
|
+
<section>
|
|
84
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
85
|
+
<h3 class="tsd-anchor-link" id="node"><code class="tsd-tag">Readonly</code><span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
86
|
+
<div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div>
|
|
87
|
+
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
88
|
+
</div><aside class="tsd-sources">
|
|
89
|
+
<p>Inherited from pj.Component.node</p></aside></section>
|
|
90
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
91
|
+
<h3 class="tsd-anchor-link" id="options"><code class="tsd-tag">Protected</code><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
92
|
+
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkflowOptions.html" class="tsd-signature-type tsd-kind-interface">WorkflowOptions</a></div>
|
|
93
|
+
<div class="tsd-comment tsd-typography"><p>The options for configuring the Workflow.</p>
|
|
94
|
+
</div></section>
|
|
95
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
96
|
+
<h3 class="tsd-anchor-link" id="project"><code class="tsd-tag">Readonly</code><span>project</span><a href="#project" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
97
|
+
<div class="tsd-signature"><span class="tsd-kind-property">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span></div><aside class="tsd-sources">
|
|
98
|
+
<p>Inherited from pj.Component.project</p></aside></section></section></details>
|
|
99
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
100
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
101
|
+
<section>
|
|
102
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
103
|
+
<h3 class="tsd-anchor-link" id="createconstructfile"><code class="tsd-tag">Protected</code><span>create<wbr/>Construct<wbr/>File</span><a href="#createconstructfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
104
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
105
|
+
<li class="">
|
|
106
|
+
<div class="tsd-signature tsd-anchor-link" id="createconstructfile-1"><span class="tsd-kind-call-signature">createConstructFile</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FileBase</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#createconstructfile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
107
|
+
<div class="tsd-description">
|
|
108
|
+
<div class="tsd-comment tsd-typography"><p>Creates the construct file content for the generated Workflow.</p>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tsd-parameters">
|
|
111
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
112
|
+
<ul class="tsd-parameter-list">
|
|
113
|
+
<li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">FileBase</span></span>
|
|
114
|
+
<div class="tsd-comment tsd-typography"><p>The file object to create content for.</p>
|
|
115
|
+
</div></li></ul></div>
|
|
116
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The content of the construct file.</p>
|
|
117
|
+
</div></li></ul></section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
119
|
+
<h3 class="tsd-anchor-link" id="postprojectcreation"><span>post<wbr/>Project<wbr/>Creation</span><a href="#postprojectcreation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
120
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
121
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
122
|
+
<div class="tsd-signature tsd-anchor-link" id="postprojectcreation-1"><span class="tsd-kind-call-signature">postProjectCreation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">initProject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InitProject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#postprojectcreation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
123
|
+
<div class="tsd-description">
|
|
124
|
+
<div class="tsd-comment tsd-typography"><p>Called once, right after <code>postSynthesize()</code>, only when the project is created for the first time.</p>
|
|
125
|
+
<p>It does not run on later <code>projen</code> invocations. It only fires for <code>projen new</code> (or <code>Projects.createProject</code>).
|
|
126
|
+
It is also skipped when post-synthesis steps are disabled, e.g. <code>--no-post</code> or <code>PROJEN_DISABLE_POST</code>.
|
|
127
|
+
Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate
|
|
128
|
+
feedback on their new project. Order across components is not guaranteed.</p>
|
|
129
|
+
</div>
|
|
130
|
+
<div class="tsd-parameters">
|
|
131
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
132
|
+
<ul class="tsd-parameter-list">
|
|
133
|
+
<li><span><span class="tsd-kind-parameter">initProject</span>: <span class="tsd-signature-type">InitProject</span></span>
|
|
134
|
+
<div class="tsd-comment tsd-typography"><p>Details about how the project was created, e.g. its type and the original CLI args.</p>
|
|
135
|
+
</div></li></ul></div>
|
|
136
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
137
|
+
<p>Inherited from pj.Component.postProjectCreation</p></aside></div></li></ul></section>
|
|
138
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
139
|
+
<h3 class="tsd-anchor-link" id="postsynthesize"><span>post<wbr/>Synthesize</span><a href="#postsynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
140
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
141
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
142
|
+
<div class="tsd-signature tsd-anchor-link" id="postsynthesize-1"><span class="tsd-kind-call-signature">postSynthesize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#postsynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
143
|
+
<div class="tsd-description">
|
|
144
|
+
<div class="tsd-comment tsd-typography"><p>Called after synthesis. Order is <em>not</em> guaranteed.</p>
|
|
145
|
+
</div>
|
|
146
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
147
|
+
<p>Inherited from pj.Component.postSynthesize</p></aside></div></li></ul></section>
|
|
148
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
149
|
+
<h3 class="tsd-anchor-link" id="presynthesize"><span>pre<wbr/>Synthesize</span><a href="#presynthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
150
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
151
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
152
|
+
<div class="tsd-signature tsd-anchor-link" id="presynthesize-1"><span class="tsd-kind-call-signature">preSynthesize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#presynthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
153
|
+
<div class="tsd-description">
|
|
154
|
+
<div class="tsd-comment tsd-typography"><p>Called before synthesis.</p>
|
|
155
|
+
</div>
|
|
156
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
157
|
+
<p>Inherited from pj.Component.preSynthesize</p></aside></div></li></ul></section>
|
|
158
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
159
|
+
<h3 class="tsd-anchor-link" id="projectcreation"><span>project<wbr/>Creation</span><a href="#projectcreation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
160
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
161
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
162
|
+
<div class="tsd-signature tsd-anchor-link" id="projectcreation-1"><span class="tsd-kind-call-signature">projectCreation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">initProject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InitProject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#projectcreation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
163
|
+
<div class="tsd-description">
|
|
164
|
+
<div class="tsd-comment tsd-typography"><p>Called once, right after <code>synthesize()</code>, only when the project is created for the first time.</p>
|
|
165
|
+
<p>It does not run on later <code>projen</code> invocations. It only fires for <code>projen new</code> (or <code>Projects.createProject</code>).
|
|
166
|
+
Use it for deterministic, one-off file generation. Order across components is not guaranteed.</p>
|
|
167
|
+
</div>
|
|
168
|
+
<div class="tsd-parameters">
|
|
169
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
170
|
+
<ul class="tsd-parameter-list">
|
|
171
|
+
<li><span><span class="tsd-kind-parameter">initProject</span>: <span class="tsd-signature-type">InitProject</span></span>
|
|
172
|
+
<div class="tsd-comment tsd-typography"><p>Details about how the project was created, e.g. its type and the original CLI args.</p>
|
|
173
|
+
</div></li></ul></div>
|
|
174
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
175
|
+
<p>Inherited from pj.Component.projectCreation</p></aside></div></li></ul></section>
|
|
176
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
177
|
+
<h3 class="tsd-anchor-link" id="renderdefinitionsubstitution"><code class="tsd-tag">Protected</code><span>render<wbr/>Definition<wbr/>Substitution</span><a href="#renderdefinitionsubstitution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
178
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
179
|
+
<li class="">
|
|
180
|
+
<div class="tsd-signature tsd-anchor-link" id="renderdefinitionsubstitution-1"><span class="tsd-kind-call-signature">renderDefinitionSubstitution</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">def</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VariableDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#renderdefinitionsubstitution-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
181
|
+
<div class="tsd-description">
|
|
182
|
+
<div class="tsd-comment tsd-typography"><p>Renders the definition substitution for a given variable.</p>
|
|
183
|
+
</div>
|
|
184
|
+
<div class="tsd-parameters">
|
|
185
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
186
|
+
<ul class="tsd-parameter-list">
|
|
187
|
+
<li><span><span class="tsd-kind-parameter">def</span>: <span class="tsd-signature-type">VariableDefinition</span></span>
|
|
188
|
+
<div class="tsd-comment tsd-typography"><p>The variable definition.</p>
|
|
189
|
+
</div></li></ul></div>
|
|
190
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The definition substitution string.</p>
|
|
191
|
+
</div></li></ul></section>
|
|
192
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
193
|
+
<h3 class="tsd-anchor-link" id="renderstateconfigdefinition"><code class="tsd-tag">Protected</code><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span><a href="#renderstateconfigdefinition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
194
|
+
<ul class="tsd-signatures tsd-is-protected">
|
|
195
|
+
<li class="">
|
|
196
|
+
<div class="tsd-signature tsd-anchor-link" id="renderstateconfigdefinition-1"><span class="tsd-kind-call-signature">renderStateConfigDefinition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">def</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VariableDefinition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#renderstateconfigdefinition-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
197
|
+
<div class="tsd-description">
|
|
198
|
+
<div class="tsd-comment tsd-typography"><p>Renders the state configuration definition for a given variable.</p>
|
|
199
|
+
</div>
|
|
200
|
+
<div class="tsd-parameters">
|
|
201
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
202
|
+
<ul class="tsd-parameter-list">
|
|
203
|
+
<li><span><span class="tsd-kind-parameter">def</span>: <span class="tsd-signature-type">VariableDefinition</span></span>
|
|
204
|
+
<div class="tsd-comment tsd-typography"><p>The variable definition.</p>
|
|
205
|
+
</div></li></ul></div>
|
|
206
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The state configuration definition string.</p>
|
|
207
|
+
</div></li></ul></section>
|
|
208
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
209
|
+
<h3 class="tsd-anchor-link" id="synthesize"><span>synthesize</span><a href="#synthesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
210
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
211
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
212
|
+
<div class="tsd-signature tsd-anchor-link" id="synthesize-1"><span class="tsd-kind-call-signature">synthesize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#synthesize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
213
|
+
<div class="tsd-description">
|
|
214
|
+
<div class="tsd-comment tsd-typography"><p>Synthesizes files to the project output directory.</p>
|
|
215
|
+
</div>
|
|
216
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
217
|
+
<p>Inherited from pj.Component.synthesize</p></aside></div></li></ul></section>
|
|
218
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
219
|
+
<h3 class="tsd-anchor-link" id="tostring"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
220
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
221
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
222
|
+
<div class="tsd-signature tsd-anchor-link" id="tostring-1"><span class="tsd-kind-call-signature">toString</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tostring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
223
|
+
<div class="tsd-description">
|
|
224
|
+
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
225
|
+
</div>
|
|
226
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
227
|
+
<p>Inherited from pj.Component.toString</p></aside></div></li></ul></section>
|
|
228
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
229
|
+
<h3 class="tsd-anchor-link" id="with"><span>with</span><a href="#with" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
230
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
231
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
232
|
+
<div class="tsd-signature tsd-anchor-link" id="with-1"><span class="tsd-kind-call-signature">with</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">mixins</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IMixin</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConstruct</span><a href="#with-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
233
|
+
<div class="tsd-description">
|
|
234
|
+
<div class="tsd-comment tsd-typography"><p>Applies one or more mixins to this construct.</p>
|
|
39
235
|
<p>Mixins are applied in order. The list of constructs is captured at the
|
|
40
236
|
start of the call, so constructs added by a mixin will not be visited.
|
|
41
237
|
Use multiple <code>with()</code> calls if subsequent mixins should apply to added
|
|
42
238
|
constructs.</p>
|
|
43
|
-
</div
|
|
44
|
-
|
|
45
|
-
<
|
|
46
|
-
|
|
239
|
+
</div>
|
|
240
|
+
<div class="tsd-parameters">
|
|
241
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
242
|
+
<ul class="tsd-parameter-list">
|
|
243
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">mixins</span>: <span class="tsd-signature-type">IMixin</span><span class="tsd-signature-symbol">[]</span></span>
|
|
244
|
+
<div class="tsd-comment tsd-typography"><p>The mixins to apply</p>
|
|
245
|
+
</div></li></ul></div>
|
|
246
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IConstruct</span></h4><p>This construct for chaining</p>
|
|
247
|
+
<aside class="tsd-sources">
|
|
248
|
+
<p>Inherited from pj.Component.with</p></aside></div></li></ul></section>
|
|
249
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
250
|
+
<h3 class="tsd-anchor-link" id="iscomponent"><code class="tsd-tag">Static</code><span>is<wbr/>Component</span><a href="#iscomponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
251
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
252
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
253
|
+
<div class="tsd-signature tsd-anchor-link" id="iscomponent-1"><span class="tsd-kind-call-signature">isComponent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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> <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Component</span><a href="#iscomponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
254
|
+
<div class="tsd-description">
|
|
255
|
+
<div class="tsd-comment tsd-typography"><p>Test whether the given construct is a component.</p>
|
|
256
|
+
</div>
|
|
257
|
+
<div class="tsd-parameters">
|
|
258
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
259
|
+
<ul class="tsd-parameter-list">
|
|
260
|
+
<li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span></li></ul></div>
|
|
261
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Component</span></h4><aside class="tsd-sources">
|
|
262
|
+
<p>Inherited from pj.Component.isComponent</p></aside></div></li></ul></section>
|
|
263
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
264
|
+
<h3 class="tsd-anchor-link" id="isconstruct"><code class="tsd-tag">Static</code><span>is<wbr/>Construct</span><a href="#isconstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
265
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
266
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
267
|
+
<div class="tsd-signature tsd-anchor-link" id="isconstruct-1"><span class="tsd-kind-call-signature">isConstruct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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> <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Construct</span><a href="#isconstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
268
|
+
<div class="tsd-description">
|
|
269
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
47
270
|
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
48
271
|
instances, even when the construct library is symlinked.</p>
|
|
49
272
|
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
@@ -56,6 +279,40 @@ use a monorepo tool: in those cases, multiple copies of the <code>constructs</co
|
|
|
56
279
|
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
57
280
|
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
58
281
|
this type-testing method instead.</p>
|
|
59
|
-
</div
|
|
60
|
-
|
|
61
|
-
<
|
|
282
|
+
</div>
|
|
283
|
+
<div class="tsd-parameters">
|
|
284
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
285
|
+
<ul class="tsd-parameter-list">
|
|
286
|
+
<li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span>
|
|
287
|
+
<div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
288
|
+
</div></li></ul></div>
|
|
289
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
290
|
+
<aside class="tsd-sources">
|
|
291
|
+
<p>Inherited from pj.Component.isConstruct</p></aside></div></li></ul></section></section></details></div>
|
|
292
|
+
<div class="col-sidebar">
|
|
293
|
+
<div class="page-menu">
|
|
294
|
+
<div class="tsd-navigation settings">
|
|
295
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
296
|
+
<h3>Settings</h3></summary>
|
|
297
|
+
<div class="tsd-accordion-details">
|
|
298
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
299
|
+
<ul id="tsd-filter-options">
|
|
300
|
+
<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>
|
|
301
|
+
<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>
|
|
302
|
+
<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></div>
|
|
303
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
304
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
305
|
+
<h3>On This Page</h3></summary>
|
|
306
|
+
<div class="tsd-accordion-details">
|
|
307
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
308
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
309
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
310
|
+
<div><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a><a href="#options" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#project" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project</span></a></div></details>
|
|
311
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
312
|
+
<div><a href="#createconstructfile" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Construct<wbr/>File</span></a><a href="#postprojectcreation" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Project<wbr/>Creation</span></a><a href="#postsynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>post<wbr/>Synthesize</span></a><a href="#presynthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Synthesize</span></a><a href="#projectcreation" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>project<wbr/>Creation</span></a><a href="#renderdefinitionsubstitution" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>Definition<wbr/>Substitution</span></a><a href="#renderstateconfigdefinition" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>render<wbr/>State<wbr/>Config<wbr/>Definition</span></a><a href="#synthesize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>synthesize</span></a><a href="#tostring" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#with" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a><a href="#iscomponent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Component</span></a><a href="#isconstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a></div></details></div></details></div>
|
|
313
|
+
<div class="site-menu">
|
|
314
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
315
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
316
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
317
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
318
|
+
<div class="overlay"></div></body></html>
|