Skip to content

Commit

Permalink
chore(release): Update API docs [skip release]
Browse files Browse the repository at this point in the history
  • Loading branch information
aws-amplify-bot committed Dec 19, 2024
1 parent 71558b7 commit 9776ac0
Show file tree
Hide file tree
Showing 61 changed files with 407 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/api/assets/navigation.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/assets/search.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@
<code>Duplex</code> will write to the <code>writable</code> and read from the <code>readable</code>.</li>
<li><code>Promise</code> converts into readable <code>Duplex</code>. Value <code>null</code> is ignored.</li>
</ul>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.Object.html" class="tsd-signature-type tsd-kind-interface">Object</a><span class="tsd-signature-symbol"> | </span><a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Stream.html" class="tsd-signature-type tsd-kind-class">Stream</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.Iterable.html" class="tsd-signature-type tsd-kind-interface">Iterable</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AsyncIterable.html" class="tsd-signature-type tsd-kind-interface">AsyncIterable</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Blob.html" class="tsd-signature-type tsd-kind-class">Blob</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AsyncGeneratorFunction.html" class="tsd-signature-type tsd-kind-interface">AsyncGeneratorFunction</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v16.8.0</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.Object.html" class="tsd-signature-type tsd-kind-interface">Object</a><span class="tsd-signature-symbol"> | </span><a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Stream.html" class="tsd-signature-type tsd-kind-class">Stream</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.Iterable.html" class="tsd-signature-type tsd-kind-interface">Iterable</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AsyncIterable.html" class="tsd-signature-type tsd-kind-interface">AsyncIterable</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Blob.html" class="tsd-signature-type tsd-kind-class">Blob</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AsyncGeneratorFunction.html" class="tsd-signature-type tsd-kind-interface">AsyncGeneratorFunction</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v16.8.0</p>
</div><aside class="tsd-sources"><p>Overrides <a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.ReadableBase.html">ReadableBase</a>.<a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.ReadableBase.html#from">from</a></p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="fromWeb" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Web</span><a href="#fromWeb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromWeb.fromWeb-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Web</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">duplexStream</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a><a href="#fromWeb.fromWeb-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code> <div class="tsd-comment tsd-typography"><p>A utility method for creating a <code>Duplex</code> from a web <code>ReadableStream</code> and <code>WritableStream</code>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">duplexStream</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">readable</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.ReadableStream.html" class="tsd-signature-type tsd-kind-interface">ReadableStream</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">writable</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.WritableStream-1.html" class="tsd-signature-type tsd-kind-interface">WritableStream</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">readable</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.ReadableStream.html" class="tsd-signature-type tsd-kind-interface">ReadableStream</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">writable</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.WritableStream-1.html" class="tsd-signature-type tsd-kind-interface">WritableStream</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.Pick.html" class="tsd-signature-type tsd-kind-type-alias">Pick</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.DuplexOptions.html" class="tsd-signature-type tsd-kind-interface">DuplexOptions</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;encoding&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;highWaterMark&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;objectMode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;signal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;decodeStrings&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;allowHalfOpen&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_aws_amplify_adapter_nextjs.index._Reference_Types_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a></h4><div class="tsd-comment tsd-typography"><h4>Since</h4><p>v17.0.0</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getEventListeners.getEventListeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Event<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><a href="#getEventListeners.getEventListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
Expand Down
Loading

0 comments on commit 9776ac0

Please sign in to comment.