Skip to content

Commit e9e9901

Browse files
author
aws-amplify-bot
committed
chore(release): Update API docs [skip release]
1 parent eacdf1a commit e9e9901

File tree

30 files changed

+58
-117
lines changed

30 files changed

+58
-117
lines changed

docs/api/assets/navigation.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api/classes/aws_amplify.adapter_core._Reference_Types_.AmplifyClass.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="aws_amplify.adapter_core._Reference_Types_.AmplifyClass.html#configure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>configure</span></a>
66
<a href="aws_amplify.adapter_core._Reference_Types_.AmplifyClass.html#getConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Config</span></a>
77
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AmplifyClass" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Amplify<wbr/>Class</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="aws_amplify.adapter_core._Reference_Types_.AmplifyClass.html" class="tsd-signature-type tsd-kind-class">AmplifyClass</a><a href="#constructor.new_AmplifyClass" 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"><h4 class="tsd-returns-title">Returns <a href="aws_amplify.adapter_core._Reference_Types_.AmplifyClass.html" class="tsd-signature-type tsd-kind-class">AmplifyClass</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="libraryOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>library<wbr/>Options</span><a href="#libraryOptions" 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">library<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/aws_amplify.adapter_core._Reference_Types_.LibraryOptions.html" class="tsd-signature-type tsd-kind-interface">LibraryOptions</a></div></section><section class="tsd-panel tsd-member"><a id="resourcesConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resources<wbr/>Config</span><a href="#resourcesConfig" 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">resources<wbr/>Config</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/aws_amplify.index.ResourcesConfig.html" class="tsd-signature-type tsd-kind-interface">ResourcesConfig</a></div></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="configure" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>configure</span><a href="#configure" 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"><li class="tsd-signature tsd-anchor-link"><a id="configure.configure-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">configure</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">resourcesConfig</span>, <span class="tsd-kind-parameter">libraryOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#configure.configure-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>Configures Amplify for use with your back-end resources.</p>
8-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">resourcesConfig</span>: <a href="../interfaces/aws_amplify.index.ResourcesConfig.html" class="tsd-signature-type tsd-kind-interface">ResourcesConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/aws_amplify.adapter_core.LegacyConfig.html" class="tsd-signature-type tsd-kind-interface">LegacyConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/aws_amplify.adapter_core.AmplifyOutputs.html" class="tsd-signature-type tsd-kind-interface">AmplifyOutputs</a></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">libraryOptions</span>: <a href="../interfaces/aws_amplify.adapter_core._Reference_Types_.LibraryOptions.html" class="tsd-signature-type tsd-kind-interface">LibraryOptions</a></h5><div class="tsd-comment tsd-typography"><p>Additional options for customizing the behavior of the library.</p>
8+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">resourcesConfig</span>: <a href="../interfaces/aws_amplify.index.ResourcesConfig.html" class="tsd-signature-type tsd-kind-interface">ResourcesConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/aws_amplify.adapter_core.LegacyConfig.html" class="tsd-signature-type tsd-kind-interface">LegacyConfig</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/aws_amplify.utils._Reference_Types_.AmplifyOutputsUnknown.html" class="tsd-signature-type tsd-kind-interface">AmplifyOutputsUnknown</a></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">libraryOptions</span>: <a href="../interfaces/aws_amplify.adapter_core._Reference_Types_.LibraryOptions.html" class="tsd-signature-type tsd-kind-interface">LibraryOptions</a></h5><div class="tsd-comment tsd-typography"><p>Additional options for customizing the behavior of the library.</p>
99
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Remarks</h4><p>This API does not perform any merging of either <code>resourcesConfig</code> or <code>libraryOptions</code>. The most recently
1010
provided values will be used after configuration.</p>
1111
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="getConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Config</span><a href="#getConfig" 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"><li class="tsd-signature tsd-anchor-link"><a id="getConfig.getConfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/aws_amplify.adapter_core._Reference_Types_.Readonly.html" class="tsd-signature-type tsd-kind-type-alias">Readonly</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/aws_amplify.index.ResourcesConfig.html" class="tsd-signature-type tsd-kind-interface">ResourcesConfig</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConfig.getConfig-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>Provides access to the current back-end resource configuration for the Library.</p>

docs/api/functions/aws_amplify.utils.parseAmplifyConfig.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/api/interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.CookiesClientParams.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/api/interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.ReqClientParams.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/api/interfaces/_aws_amplify_adapter_nextjs.index.NextServer.CreateServerRunnerInput.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/api/interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AmplifyOutputs.html

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/api/interfaces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AmplifyOutputsAnalyticsProperties.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)