Skip to content

Commit

Permalink
chore: self mutation
Browse files Browse the repository at this point in the history
Signed-off-by: github-actions <[email protected]>
  • Loading branch information
github-actions committed Oct 28, 2024
1 parent 7e48fc2 commit 11177df
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 8 deletions.
6 changes: 4 additions & 2 deletions docs/projen/classes/ServerlessProject.html
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,8 @@ <h3 class="tsd-anchor-link"><span>max<wbr/>Node<wbr/>Version</span><a href="#max
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature" id="maxNodeVersion.maxNodeVersion-1"><span class="tsd-signature-symbol">get</span> maxNodeVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Maximum node version required by this package.</p>
<div class="tsd-comment tsd-typography"><p>Maximum node version supported by this package.</p>
<p>The value indicates the package is incompatible with newer versions.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
Expand All @@ -617,7 +618,8 @@ <h3 class="tsd-anchor-link"><span>min<wbr/>Node<wbr/>Version</span><a href="#min
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature" id="minNodeVersion.minNodeVersion-1"><span class="tsd-signature-symbol">get</span> minNodeVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Minimum node.js version required by this package.</p>
<div class="tsd-comment tsd-typography"><p>The minimum node version required by this package to function.</p>
<p>This value indicates the package is incompatible with older versions.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
Expand Down
26 changes: 20 additions & 6 deletions docs/projen/interfaces/ServerlessProjectOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -1032,10 +1032,15 @@ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxNodeVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max<wbr/>Node<wbr/>Version</span><a href="#maxNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Minimum node.js version to require via <code>engines</code> (inclusive).</p>
<div class="tsd-comment tsd-typography"><p>The maximum node version supported by this package.
Most projects should not use this option.</p>
<p>The value indicates that the package is incompatible with any newer versions of node.
This requirement is enforced via the engines field.</p>
<p>You will normally not need to set this option.
Consider this option only if your package is known to not function with newer versions of node.</p>
</div>
<div class="tsd-comment tsd-typography">
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">max</span>
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">maximum</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">enforced</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.maxNodeVersion</p></aside></section>
Expand Down Expand Up @@ -1079,10 +1084,18 @@ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minNodeVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>min<wbr/>Node<wbr/>Version</span><a href="#minNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">min<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Minimum Node.js version to require via package.json <code>engines</code> (inclusive).</p>
<div class="tsd-comment tsd-typography"><p>The minimum node version required by this package to function.
Most projects should not use this option.</p>
<p>The value indicates that the package is incompatible with any older versions of node.
This requirement is enforced via the engines field.</p>
<p>You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
Setting this option has very high impact on the consumers of your package,
as package managers will actively prevent usage with node versions you have marked as incompatible.</p>
<p>To change the node version of your CI/CD workflows, use <code>workflowNodeVersion</code>.</p>
</div>
<div class="tsd-comment tsd-typography">
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-2">&quot;engines&quot;</span><span class="hl-1"> </span><span class="hl-4">specified</span>
<h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">no</span><span class="hl-1"> </span><span class="hl-4">minimum</span><span class="hl-1"> </span><span class="hl-4">version</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">enforced</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.minNodeVersion</p></aside></section>
Expand Down Expand Up @@ -1945,11 +1958,12 @@ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="workflowNodeVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workflow<wbr/>Node<wbr/>Version</span><a href="#workflowNodeVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">workflow<wbr/>Node<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The node version to use in GitHub workflows.</p>
<div class="tsd-comment tsd-typography"><p>The node version used in GitHub Actions workflows.</p>
<p>Always use this option if your GitHub Actions workflows require a specific to run.</p>
</div>
<div class="tsd-comment tsd-typography">
<h4>Default</h4><ul>
<li>same as <code>minNodeVersion</code></li>
<li><code>minNodeVersion</code> if set, otherwise <code>lts/*</code>.</li>
</ul>
</div><aside class="tsd-sources">
<p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowNodeVersion</p></aside></section>
Expand Down

0 comments on commit 11177df

Please sign in to comment.