@nikovirtala/projen-constructs 0.2.157 → 0.3.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.
Files changed (106) hide show
  1. package/.jsii +1077 -818
  2. package/.kiro/steering/product.md +1 -1
  3. package/.kiro/steering/tech.md +6 -4
  4. package/API.md +9711 -5492
  5. package/docs/api/assets/highlight.css +1 -1
  6. package/docs/api/assets/main.js +1 -1
  7. package/docs/api/assets/search.js +1 -1
  8. package/docs/api/assets/style.css +18 -3
  9. package/docs/api/classes/AwsCdkConstructLibraryProject.html +997 -162
  10. package/docs/api/classes/AwsCdkTypeScriptAppProject.html +1015 -157
  11. package/docs/api/classes/Bundler.html +267 -17
  12. package/docs/api/classes/Colima.html +221 -16
  13. package/docs/api/classes/Homebrew.html +244 -16
  14. package/docs/api/classes/JsiiProject.html +983 -150
  15. package/docs/api/classes/LambdaFunctionCodeBundle.html +222 -16
  16. package/docs/api/classes/LambdaFunctionCodeBundler.html +222 -16
  17. package/docs/api/classes/LambdaFunctionConstructGenerator.html +243 -16
  18. package/docs/api/classes/LocalStack.html +222 -16
  19. package/docs/api/classes/Mise.html +233 -16
  20. package/docs/api/classes/ProjectGenerator.html +229 -19
  21. package/docs/api/classes/TypeDoc.html +246 -19
  22. package/docs/api/classes/TypeScriptProject.html +983 -150
  23. package/docs/api/classes/Vitest.html +295 -16
  24. package/docs/api/enums/CommentStyle.html +74 -8
  25. package/docs/api/enums/CoverageProvider.html +65 -6
  26. package/docs/api/enums/CoverageReporter.html +72 -7
  27. package/docs/api/enums/EntryPointStrategy.html +74 -8
  28. package/docs/api/enums/Environment.html +79 -9
  29. package/docs/api/enums/LogLevel.html +79 -9
  30. package/docs/api/enums/Pool.html +75 -8
  31. package/docs/api/enums/ProjectType.html +149 -27
  32. package/docs/api/enums/Visibility.html +69 -7
  33. package/docs/api/functions/applyDefaults.html +41 -1
  34. package/docs/api/functions/convertToPosixPath.html +40 -1
  35. package/docs/api/functions/renderBundleName.html +40 -1
  36. package/docs/api/functions/toJson_TypeDocConfiguration.html +42 -2
  37. package/docs/api/hierarchy.html +29 -1
  38. package/docs/api/index.html +60 -2
  39. package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +2404 -770
  40. package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +2302 -740
  41. package/docs/api/interfaces/Bundle.html +57 -2
  42. package/docs/api/interfaces/BundlerOptions.html +60 -2
  43. package/docs/api/interfaces/BundlingOptions.html +84 -2
  44. package/docs/api/interfaces/Component.html +70 -7
  45. package/docs/api/interfaces/ComponentOptions.html +66 -6
  46. package/docs/api/interfaces/HomebrewOptions.html +51 -2
  47. package/docs/api/interfaces/JsiiProjectOptions.html +2263 -713
  48. package/docs/api/interfaces/LambdaFunctionCodeBundleOptions.html +63 -2
  49. package/docs/api/interfaces/LambdaFunctionCodeBundlerOptions.html +57 -2
  50. package/docs/api/interfaces/LambdaFunctionConstructGeneratorOptions.html +72 -2
  51. package/docs/api/interfaces/LocalStackOptions.html +60 -2
  52. package/docs/api/interfaces/MiseOptions.html +51 -2
  53. package/docs/api/interfaces/ProjectGeneratorOptions.html +136 -20
  54. package/docs/api/interfaces/TypeDocConfiguration.html +469 -96
  55. package/docs/api/interfaces/TypeDocOptions.html +62 -5
  56. package/docs/api/interfaces/TypeScriptProjectOptions.html +2032 -638
  57. package/docs/api/interfaces/ValidationOptions.html +70 -7
  58. package/docs/api/interfaces/VitestConfigOptions.html +268 -57
  59. package/docs/api/interfaces/VitestOptions.html +71 -7
  60. package/docs/api/modules.html +52 -1
  61. package/docs/api/variables/defaultOptions.html +40 -1
  62. package/docs/api/variables/defaults.html +48 -1
  63. package/docs/api/variables/projectDefaultOptions.html +120 -1
  64. package/lib/bundle-vitest-define-config.js +37 -4
  65. package/lib/components/bundle-lambda-function-code.js +43 -9
  66. package/lib/components/colima.js +6 -4
  67. package/lib/components/homebrew.js +10 -4
  68. package/lib/components/lambda-function-construct-generator.js +47 -6
  69. package/lib/components/localstack.js +2 -4
  70. package/lib/components/mise.js +2 -4
  71. package/lib/components/typedoc.js +11 -4
  72. package/lib/components/vitest.d.ts +1 -1
  73. package/lib/components/vitest.js +58 -6
  74. package/lib/config.d.ts +52 -6
  75. package/lib/config.js +87 -10
  76. package/lib/errors.js +7 -1
  77. package/lib/project-generator.js +46 -9
  78. package/lib/project-type.d.ts +0 -8
  79. package/lib/project-type.js +1 -9
  80. package/lib/projects/awscdk-construct-library-options.generated.d.ts +72 -18
  81. package/lib/projects/awscdk-construct-library-options.generated.js +1 -1
  82. package/lib/projects/awscdk-construct-library.generated.d.ts +1 -1
  83. package/lib/projects/awscdk-construct-library.generated.js +2 -4
  84. package/lib/projects/awscdk-typescript-app-options.generated.d.ts +63 -17
  85. package/lib/projects/awscdk-typescript-app-options.generated.js +1 -1
  86. package/lib/projects/awscdk-typescript-app.generated.d.ts +1 -1
  87. package/lib/projects/awscdk-typescript-app.generated.js +2 -4
  88. package/lib/projects/jsii-options.generated.d.ts +72 -10
  89. package/lib/projects/jsii-options.generated.js +1 -1
  90. package/lib/projects/jsii.generated.d.ts +1 -1
  91. package/lib/projects/jsii.generated.js +2 -4
  92. package/lib/projects/typescript-options.generated.d.ts +63 -9
  93. package/lib/projects/typescript-options.generated.js +1 -1
  94. package/lib/projects/typescript.generated.d.ts +1 -1
  95. package/lib/projects/typescript.generated.js +2 -4
  96. package/lib/utils.d.ts +8 -0
  97. package/lib/utils.js +11 -2
  98. package/node_modules/@jsii/spec/lib/assembly-utils.js +36 -3
  99. package/node_modules/@jsii/spec/lib/validators.js +1 -1
  100. package/node_modules/@jsii/spec/package.json +4 -4
  101. package/package.json +19 -20
  102. package/pnpm-workspace.yaml +8 -0
  103. package/lib/components/vitest-bundled-define-config.d.ts +0 -1
  104. package/lib/components/vitest-bundled-define-config.js +0 -6
  105. package/lib/vitest-define-config-entry.d.ts +0 -1
  106. package/lib/vitest-define-config-entry.js +0 -6
@@ -1,34 +1,210 @@
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>ProjectGenerator | @nikovirtala/projen-constructs</title><meta name="description" content="Documentation for @nikovirtala/projen-constructs"/><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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-constructs</a><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"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><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><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ProjectGenerator</a></li></ul><h1>Class ProjectGenerator</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Projen component that generates TypeScript project classes with standard configuration</p>
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>ProjectGenerator | @nikovirtala/projen-constructs</title><meta name="description" content="Documentation for @nikovirtala/projen-constructs"/><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">@nikovirtala/projen-constructs</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">ProjectGenerator</a></li></ul>
12
+ <h1>Class ProjectGenerator</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>Projen component that generates TypeScript project classes with standard configuration</p>
2
15
  <p>This component automates the creation of project classes that extend Projen base classes
3
16
  with opinionated defaults and component integration.</p>
4
- </div></section><section class="tsd-panel tsd-hierarchy" data-refl="639"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Component</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ProjectGenerator</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-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><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>
5
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><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>
17
+ </div></section>
18
+ <section class="tsd-panel tsd-hierarchy" data-refl="712">
19
+ <h4>Hierarchy</h4>
20
+ <ul class="tsd-hierarchy">
21
+ <li class="tsd-hierarchy-item"><span class="tsd-signature-type">Component</span>
22
+ <ul class="tsd-hierarchy">
23
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ProjectGenerator</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-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>
27
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
28
+ <div class="tsd-accordion-details">
29
+ <section class="tsd-index-section">
30
+ <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>
31
+ <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>
32
+ </div></section>
33
+ <section class="tsd-index-section">
34
+ <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>
35
+ <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>
6
36
  <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>
7
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><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>
37
+ </div></section>
38
+ <section class="tsd-index-section">
39
+ <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>
40
+ <div class="tsd-index-list"><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>
41
+ <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>
8
42
  <a href="#presynthesize" class="tsd-index-link"><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>
43
+ <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>
9
44
  <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>
10
45
  <a href="#tostring" 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>to<wbr/>String</span></a>
11
46
  <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>
12
47
  <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>
13
48
  <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>
14
- </div></section></div></details></section></section><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><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorprojectgenerator"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ProjectGenerator</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ProjectGeneratorOptions.html" class="tsd-signature-type tsd-kind-interface">ProjectGeneratorOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ProjectGenerator</a><a href="#constructorprojectgenerator" 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><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">project</span>: <span class="tsd-signature-type">Project</span></span><div class="tsd-comment tsd-typography"><p>Projen project instance</p>
15
- </div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ProjectGeneratorOptions.html" class="tsd-signature-type tsd-kind-interface">ProjectGeneratorOptions</a></span><div class="tsd-comment tsd-typography"><p>Generator configuration</p>
16
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ProjectGenerator</a></h4><aside class="tsd-sources"><p>Overrides projen.Component.constructor</p></aside></div></li></ul></section></section></details><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><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><div class="tsd-comment tsd-typography"><p>The tree node.</p>
17
- </div><aside class="tsd-sources"><p>Inherited from projen.Component.node</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><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"><p>Inherited from projen.Component.project</p></aside></section></section></details><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><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called after synthesis. Order is <em>not</em> guaranteed.</p>
18
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from projen.Component.postSynthesize</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><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><ul class="tsd-signatures"><li class=""><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Generates the TypeScript class file during Projen synthesis</p>
49
+ </div></section></div></details></section></section>
50
+ <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>
51
+ <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>
52
+ <section>
53
+ <section class="tsd-panel tsd-member">
54
+ <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>
55
+ <ul class="tsd-signatures">
56
+ <li class="">
57
+ <div class="tsd-signature tsd-anchor-link" id="constructorprojectgenerator"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ProjectGenerator</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ProjectGeneratorOptions.html" class="tsd-signature-type tsd-kind-interface">ProjectGeneratorOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ProjectGenerator</a><a href="#constructorprojectgenerator" 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>
58
+ <div class="tsd-description">
59
+ <div class="tsd-parameters">
60
+ <h4 class="tsd-parameters-title">Parameters</h4>
61
+ <ul class="tsd-parameter-list">
62
+ <li><span><span class="tsd-kind-parameter">project</span>: <span class="tsd-signature-type">Project</span></span>
63
+ <div class="tsd-comment tsd-typography"><p>Projen project instance</p>
64
+ </div></li>
65
+ <li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ProjectGeneratorOptions.html" class="tsd-signature-type tsd-kind-interface">ProjectGeneratorOptions</a></span>
66
+ <div class="tsd-comment tsd-typography"><p>Generator configuration</p>
67
+ </div></li></ul></div>
68
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ProjectGenerator</a></h4><aside class="tsd-sources">
69
+ <p>Overrides projen.Component.constructor</p></aside></div></li></ul></section></section></details>
70
+ <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>
71
+ <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>
72
+ <section>
73
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
74
+ <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>
75
+ <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>
76
+ <div class="tsd-comment tsd-typography"><p>The tree node.</p>
77
+ </div><aside class="tsd-sources">
78
+ <p>Inherited from projen.Component.node</p></aside></section>
79
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
80
+ <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>
81
+ <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">
82
+ <p>Inherited from projen.Component.project</p></aside></section></section></details>
83
+ <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>
84
+ <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>
85
+ <section>
86
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
87
+ <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>
88
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
89
+ <li class="tsd-is-inherited tsd-is-external">
90
+ <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>
91
+ <div class="tsd-description">
92
+ <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>
93
+ <p>It does not run on later <code>projen</code> invocations. It only fires for <code>projen new</code> (or <code>Projects.createProject</code>).
94
+ It is also skipped when post-synthesis steps are disabled, e.g. <code>--no-post</code> or <code>PROJEN_DISABLE_POST</code>.
95
+ Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate
96
+ feedback on their new project. Order across components is not guaranteed.</p>
97
+ </div>
98
+ <div class="tsd-parameters">
99
+ <h4 class="tsd-parameters-title">Parameters</h4>
100
+ <ul class="tsd-parameter-list">
101
+ <li><span><span class="tsd-kind-parameter">initProject</span>: <span class="tsd-signature-type">InitProject</span></span>
102
+ <div class="tsd-comment tsd-typography"><p>Details about how the project was created, e.g. its type and the original CLI args.</p>
103
+ </div></li></ul></div>
104
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
105
+ <p>Inherited from projen.Component.postProjectCreation</p></aside></div></li></ul></section>
106
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
107
+ <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>
108
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
109
+ <li class="tsd-is-inherited tsd-is-external">
110
+ <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>
111
+ <div class="tsd-description">
112
+ <div class="tsd-comment tsd-typography"><p>Called after synthesis. Order is <em>not</em> guaranteed.</p>
113
+ </div>
114
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
115
+ <p>Inherited from projen.Component.postSynthesize</p></aside></div></li></ul></section>
116
+ <section class="tsd-panel tsd-member">
117
+ <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>
118
+ <ul class="tsd-signatures">
119
+ <li class="">
120
+ <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>
121
+ <div class="tsd-description">
122
+ <div class="tsd-comment tsd-typography"><p>Generates the TypeScript class file during Projen synthesis</p>
19
123
  <p>Called by Projen during the synthesis phase to generate the project class file.
20
124
  The file is marked as readonly to prevent manual editing.</p>
21
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides projen.Component.preSynthesize</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Synthesizes files to the project output directory.</p>
22
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from projen.Component.synthesize</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
23
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from projen.Component.toString</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Applies one or more mixins to this construct.</p>
125
+ </div>
126
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
127
+ <p>Overrides projen.Component.preSynthesize</p></aside></div></li></ul></section>
128
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
129
+ <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>
130
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
131
+ <li class="tsd-is-inherited tsd-is-external">
132
+ <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>
133
+ <div class="tsd-description">
134
+ <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>
135
+ <p>It does not run on later <code>projen</code> invocations. It only fires for <code>projen new</code> (or <code>Projects.createProject</code>).
136
+ Use it for deterministic, one-off file generation. Order across components is not guaranteed.</p>
137
+ </div>
138
+ <div class="tsd-parameters">
139
+ <h4 class="tsd-parameters-title">Parameters</h4>
140
+ <ul class="tsd-parameter-list">
141
+ <li><span><span class="tsd-kind-parameter">initProject</span>: <span class="tsd-signature-type">InitProject</span></span>
142
+ <div class="tsd-comment tsd-typography"><p>Details about how the project was created, e.g. its type and the original CLI args.</p>
143
+ </div></li></ul></div>
144
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
145
+ <p>Inherited from projen.Component.projectCreation</p></aside></div></li></ul></section>
146
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
147
+ <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>
148
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
149
+ <li class="tsd-is-inherited tsd-is-external">
150
+ <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>
151
+ <div class="tsd-description">
152
+ <div class="tsd-comment tsd-typography"><p>Synthesizes files to the project output directory.</p>
153
+ </div>
154
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
155
+ <p>Inherited from projen.Component.synthesize</p></aside></div></li></ul></section>
156
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
157
+ <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>
158
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
159
+ <li class="tsd-is-inherited tsd-is-external">
160
+ <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>
161
+ <div class="tsd-description">
162
+ <div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
163
+ </div>
164
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
165
+ <p>Inherited from projen.Component.toString</p></aside></div></li></ul></section>
166
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
167
+ <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>
168
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
169
+ <li class="tsd-is-inherited tsd-is-external">
170
+ <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>
171
+ <div class="tsd-description">
172
+ <div class="tsd-comment tsd-typography"><p>Applies one or more mixins to this construct.</p>
24
173
  <p>Mixins are applied in order. The list of constructs is captured at the
25
174
  start of the call, so constructs added by a mixin will not be visited.
26
175
  Use multiple <code>with()</code> calls if subsequent mixins should apply to added
27
176
  constructs.</p>
28
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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><div class="tsd-comment tsd-typography"><p>The mixins to apply</p>
29
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IConstruct</span></h4><p>This construct for chaining</p>
30
- <aside class="tsd-sources"><p>Inherited from projen.Component.with</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Test whether the given construct is a component.</p>
31
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><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"><p>Inherited from projen.Component.isComponent</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><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><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><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><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
177
+ </div>
178
+ <div class="tsd-parameters">
179
+ <h4 class="tsd-parameters-title">Parameters</h4>
180
+ <ul class="tsd-parameter-list">
181
+ <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>
182
+ <div class="tsd-comment tsd-typography"><p>The mixins to apply</p>
183
+ </div></li></ul></div>
184
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IConstruct</span></h4><p>This construct for chaining</p>
185
+ <aside class="tsd-sources">
186
+ <p>Inherited from projen.Component.with</p></aside></div></li></ul></section>
187
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
188
+ <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>
189
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
190
+ <li class="tsd-is-inherited tsd-is-external">
191
+ <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>
192
+ <div class="tsd-description">
193
+ <div class="tsd-comment tsd-typography"><p>Test whether the given construct is a component.</p>
194
+ </div>
195
+ <div class="tsd-parameters">
196
+ <h4 class="tsd-parameters-title">Parameters</h4>
197
+ <ul class="tsd-parameter-list">
198
+ <li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span></li></ul></div>
199
+ <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">
200
+ <p>Inherited from projen.Component.isComponent</p></aside></div></li></ul></section>
201
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
202
+ <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>
203
+ <ul class="tsd-signatures tsd-is-inherited tsd-is-external">
204
+ <li class="tsd-is-inherited tsd-is-external">
205
+ <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>
206
+ <div class="tsd-description">
207
+ <div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
32
208
  <p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
33
209
  instances, even when the construct library is symlinked.</p>
34
210
  <p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
@@ -41,6 +217,40 @@ use a monorepo tool: in those cases, multiple copies of the <code>constructs</co
41
217
  library can be accidentally installed, and <code>instanceof</code> will behave
42
218
  unpredictably. It is safest to avoid using <code>instanceof</code>, and using
43
219
  this type-testing method instead.</p>
44
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Any object</p>
45
- </div></li></ul></div><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>
46
- <aside class="tsd-sources"><p>Inherited from projen.Component.isConstruct</p></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><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><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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><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><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><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><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="#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><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><div><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"><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="#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><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
220
+ </div>
221
+ <div class="tsd-parameters">
222
+ <h4 class="tsd-parameters-title">Parameters</h4>
223
+ <ul class="tsd-parameter-list">
224
+ <li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span>
225
+ <div class="tsd-comment tsd-typography"><p>Any object</p>
226
+ </div></li></ul></div>
227
+ <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>
228
+ <aside class="tsd-sources">
229
+ <p>Inherited from projen.Component.isConstruct</p></aside></div></li></ul></section></section></details></div>
230
+ <div class="col-sidebar">
231
+ <div class="page-menu">
232
+ <div class="tsd-navigation settings">
233
+ <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>
234
+ <h3>Settings</h3></summary>
235
+ <div class="tsd-accordion-details">
236
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
237
+ <ul id="tsd-filter-options">
238
+ <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>
239
+ <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>
240
+ <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>
241
+ <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>
242
+ <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>
243
+ <h3>On This Page</h3></summary>
244
+ <div class="tsd-accordion-details">
245
+ <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>
246
+ <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>
247
+ <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>
248
+ <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="#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>
249
+ <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>
250
+ <div><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"><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="#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>
251
+ <div class="site-menu">
252
+ <nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a>
253
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
254
+ <li>Loading...</li></ul></nav></div></div></div><footer>
255
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
256
+ <div class="overlay"></div></body></html>