Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Merge release into main #14077

Merged
merged 4 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
@@ -1,7 +1,7 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GraphQLOptionsV6 | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.html">@aws-amplify/adapter-nextjs</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.api.html">api</a></li><li><a href="../modules/_aws_amplify_adapter_nextjs.api._Reference_Types_.html">&lt;Reference Types&gt;</a></li><li><a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html">GraphQLOptionsV6</a></li></ul><h1>Interface GraphQLOptionsV6&lt;FALLBACK_TYPES, TYPED_GQL_STRING&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>API V6 <code>graphql({options})</code> type that can leverage branded graphql <code>query</code>
objects and fallback types.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GraphQLOptionsV6</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#FALLBACK_TYPES">FALLBACK_TYPES</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#TYPED_GQL_STRING">TYPED_GQL_STRING</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authMode">authMode</a><span class="tsd-signature-symbol">?: </span><a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLAuthMode.html" class="tsd-signature-type tsd-kind-type-alias">GraphQLAuthMode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authToken">authToken</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#query">query</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#TYPED_GQL_STRING">TYPED_GQL_STRING</a><span class="tsd-signature-symbol"> | </span><a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.DocumentNode.html" class="tsd-signature-type tsd-kind-interface">DocumentNode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#userAgentSuffix">userAgentSuffix</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#variables">variables</a><span class="tsd-signature-symbol">?: </span><a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLVariablesV6.html" class="tsd-signature-type tsd-kind-type-alias">GraphQLVariablesV6</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#FALLBACK_TYPES">FALLBACK_TYPES</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#TYPED_GQL_STRING">TYPED_GQL_STRING</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="FALLBACK_TYPES" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">FALLBACK_TYPES</span> = <span class="tsd-signature-type">unknown</span></h4></li><li><h4><a id="TYPED_GQL_STRING" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TYPED_GQL_STRING</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span> = <span class="tsd-signature-type">string</span></h4></li></ul></section> <section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auth<wbr/>Mode?</span></a>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GraphQLOptionsV6</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#FALLBACK_TYPES">FALLBACK_TYPES</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#TYPED_GQL_STRING">TYPED_GQL_STRING</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authMode">authMode</a><span class="tsd-signature-symbol">?: </span><a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLAuthMode.html" class="tsd-signature-type tsd-kind-type-alias">GraphQLAuthMode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authToken">authToken</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#query">query</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#TYPED_GQL_STRING">TYPED_GQL_STRING</a><span class="tsd-signature-symbol"> | </span><a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.DocumentNode.html" class="tsd-signature-type tsd-kind-interface">DocumentNode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#userAgentSuffix">userAgentSuffix</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#variables">variables</a><span class="tsd-signature-symbol">?: </span><a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLVariablesV6.html" class="tsd-signature-type tsd-kind-type-alias">GraphQLVariablesV6</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#FALLBACK_TYPES">FALLBACK_TYPES</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#TYPED_GQL_STRING">TYPED_GQL_STRING</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="FALLBACK_TYPES" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">FALLBACK_TYPES</span> = <span class="tsd-signature-type">unknown</span></h4></li><li><h4><a id="TYPED_GQL_STRING" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TYPED_GQL_STRING</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span> = <span class="tsd-signature-type">string</span></h4></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#@aws-amplify/adapter-nextjs.api.<Reference Types>.GraphQLOptionsV6">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.Record.html" class="tsd-signature-type tsd-kind-type-alias">Record</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">GraphQLOptionsV6</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auth<wbr/>Mode?</span></a>
<a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#authToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auth<wbr/>Token?</span></a>
<a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#query" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>query</span></a>
<a href="_aws_amplify_adapter_nextjs.api._Reference_Types_.GraphQLOptionsV6.html#userAgentSuffix" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>user<wbr/>Agent<wbr/>Suffix?</span></a>
Expand Down

Large diffs are not rendered by default.

Loading
Loading