prismic-javascript
Version:
JavaScript development kit for prismic.io
701 lines • 60.2 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ResolvedApi | prismic-javascript</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">prismic-javascript</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="resolvedapi.html">ResolvedApi</a>
</li>
</ul>
<h1>Class ResolvedApi</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ResolvedApi</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/client.html" class="tsd-signature-type">Client</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#bookmarks" class="tsd-kind-icon">bookmarks</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#experiments" class="tsd-kind-icon">experiments</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#httpclient" class="tsd-kind-icon">http<wbr>Client</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#languages" class="tsd-kind-icon">languages</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#masterref" class="tsd-kind-icon">master<wbr>Ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#refs" class="tsd-kind-icon">refs</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#tags" class="tsd-kind-icon">tags</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#types" class="tsd-kind-icon">types</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#currentexperiment" class="tsd-kind-icon">current<wbr>Experiment</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#everything" class="tsd-kind-icon">everything</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#form" class="tsd-kind-icon">form</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#getbookmark" class="tsd-kind-icon">get<wbr>Bookmark</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#getbyid" class="tsd-kind-icon">get<wbr>ByID</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#getbyids" class="tsd-kind-icon">get<wbr>ByIDs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#getbyuid" class="tsd-kind-icon">get<wbr>ByUID</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#getpreviewresolver" class="tsd-kind-icon">get<wbr>Preview<wbr>Resolver</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#getsingle" class="tsd-kind-icon">get<wbr>Single</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#master" class="tsd-kind-icon">master</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#previewsession" class="tsd-kind-icon">preview<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#query" class="tsd-kind-icon">query</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#queryfirst" class="tsd-kind-icon">query<wbr>First</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="resolvedapi.html#ref" class="tsd-kind-icon">ref</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Resolved<wbr>Api<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/apidata.html" class="tsd-signature-type">ApiData</a>, httpClient<span class="tsd-signature-symbol">: </span><a href="httpclient.html" class="tsd-signature-type">HttpClient</a>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/resolvedapioptions.html" class="tsd-signature-type">ResolvedApiOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="resolvedapi.html" class="tsd-signature-type">ResolvedApi</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L65">ResolvedApi.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <a href="../interfaces/apidata.html" class="tsd-signature-type">ApiData</a></h5>
</li>
<li>
<h5>httpClient: <a href="httpclient.html" class="tsd-signature-type">HttpClient</a></h5>
</li>
<li>
<h5>options: <a href="../interfaces/resolvedapioptions.html" class="tsd-signature-type">ResolvedApiOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="resolvedapi.html" class="tsd-signature-type">ResolvedApi</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="bookmarks" class="tsd-anchor"></a>
<h3>bookmarks</h3>
<div class="tsd-signature tsd-kind-icon">bookmarks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L61">ResolvedApi.ts:61</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../interfaces/apidata.html" class="tsd-signature-type">ApiData</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L56">ResolvedApi.ts:56</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="experiments" class="tsd-anchor"></a>
<h3>experiments</h3>
<div class="tsd-signature tsd-kind-icon">experiments<span class="tsd-signature-symbol">:</span> <a href="experiments.html" class="tsd-signature-type">Experiments</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L58">ResolvedApi.ts:58</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="httpclient" class="tsd-anchor"></a>
<h3>http<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">http<wbr>Client<span class="tsd-signature-symbol">:</span> <a href="httpclient.html" class="tsd-signature-type">HttpClient</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L60">ResolvedApi.ts:60</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="languages" class="tsd-anchor"></a>
<h3>languages</h3>
<div class="tsd-signature tsd-kind-icon">languages<span class="tsd-signature-symbol">:</span> <a href="../interfaces/language.html" class="tsd-signature-type">Language</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L65">ResolvedApi.ts:65</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="masterref" class="tsd-anchor"></a>
<h3>master<wbr>Ref</h3>
<div class="tsd-signature tsd-kind-icon">master<wbr>Ref<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ref.html" class="tsd-signature-type">Ref</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L57">ResolvedApi.ts:57</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="options" class="tsd-anchor"></a>
<h3>options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/resolvedapioptions.html" class="tsd-signature-type">ResolvedApiOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L59">ResolvedApi.ts:59</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="refs" class="tsd-anchor"></a>
<h3>refs</h3>
<div class="tsd-signature tsd-kind-icon">refs<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ref.html" class="tsd-signature-type">Ref</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L62">ResolvedApi.ts:62</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="tags" class="tsd-anchor"></a>
<h3>tags</h3>
<div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L63">ResolvedApi.ts:63</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="types" class="tsd-anchor"></a>
<h3>types</h3>
<div class="tsd-signature tsd-kind-icon">types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L64">ResolvedApi.ts:64</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="currentexperiment" class="tsd-anchor"></a>
<h3>current<wbr>Experiment</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">current<wbr>Experiment<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="experiment.html" class="tsd-signature-type">Experiment</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L118">ResolvedApi.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="experiment.html" class="tsd-signature-type">Experiment</a>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">null</span>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="everything" class="tsd-anchor"></a>
<h3>everything</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">everything<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="searchform.html" class="tsd-signature-type">SearchForm</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L93">ResolvedApi.ts:93</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="searchform.html" class="tsd-signature-type">SearchForm</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="form" class="tsd-anchor"></a>
<h3>form</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">form<span class="tsd-signature-symbol">(</span>formId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="searchform.html" class="tsd-signature-type">SearchForm</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L85">ResolvedApi.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a useable form from its id, as described in the RESTful description of the API.
For instance: api.form("everything") works on every repository (as "everything" exists by default)
You can then chain the calls: api.form("everything").query('[[:d = at(document.id, "UkL0gMuvzYUANCpf")]]').ref(ref).submit()</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>formId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="searchform.html" class="tsd-signature-type">SearchForm</a>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">null</span>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getbookmark" class="tsd-anchor"></a>
<h3>get<wbr>Bookmark</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>Bookmark<span class="tsd-signature-symbol">(</span>bookmark<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maybeOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#getbookmark">getBookmark</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L217">ResolvedApi.ts:217</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve the document with the given bookmark</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bookmark: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maybeOptions: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getbyid" class="tsd-anchor"></a>
<h3>get<wbr>ByID</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>ByID<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maybeOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#getbyid">getByID</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L180">ResolvedApi.ts:180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve the document with the given id</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maybeOptions: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getbyids" class="tsd-anchor"></a>
<h3>get<wbr>ByIDs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>ByIDs<span class="tsd-signature-symbol">(</span>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, maybeOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#getbyids">getByIDs</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L189">ResolvedApi.ts:189</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve multiple documents from an array of id</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maybeOptions: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getbyuid" class="tsd-anchor"></a>
<h3>get<wbr>ByUID</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>ByUID<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maybeOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#getbyuid">getByUID</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L198">ResolvedApi.ts:198</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve the document with the given uid</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>uid: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maybeOptions: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getpreviewresolver" class="tsd-anchor"></a>
<h3>get<wbr>Preview<wbr>Resolver</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>Preview<wbr>Resolver<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, documentId<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/previewresolver.html" class="tsd-signature-type">PreviewResolver</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#getpreviewresolver">getPreviewResolver</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L226">ResolvedApi.ts:226</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>token: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> documentId: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/previewresolver.html" class="tsd-signature-type">PreviewResolver</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="getsingle" class="tsd-anchor"></a>
<h3>get<wbr>Single</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>Single<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maybeOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#getsingle">getSingle</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L209">ResolvedApi.ts:209</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve the singleton document with the given type</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> maybeOptions: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="master" class="tsd-anchor"></a>
<h3>master</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">master<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L104">ResolvedApi.ts:104</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ID of the master ref on this prismic.io API.
Do not use like this: searchForm.ref(api.master()).
Instead, set your ref once in a variable, and call it when you need it; this will allow to change the ref you're viewing easily for your entire page.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="previewsession" class="tsd-anchor"></a>
<h3>preview<wbr>Session</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">preview<wbr>Session<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, linkResolver<span class="tsd-signature-symbol">: </span><a href="../globals.html#linkresolver" class="tsd-signature-type">LinkResolver</a>, defaultUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L230">ResolvedApi.ts:230</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>token: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>linkResolver: <a href="../globals.html#linkresolver" class="tsd-signature-type">LinkResolver</a></h5>
</li>
<li>
<h5>defaultUrl: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="query" class="tsd-anchor"></a>
<h3>query</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">query<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, optionsOrCallback<span class="tsd-signature-symbol">: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a><span class="tsd-signature-symbol"> | </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#query">query</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L125">ResolvedApi.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Query the repository</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>q: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>optionsOrCallback: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a><span class="tsd-signature-symbol"> | </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = () => {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="queryfirst" class="tsd-anchor"></a>
<h3>query<wbr>First</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">query<wbr>First<span class="tsd-signature-symbol">(</span>q<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, optionsOrCallback<span class="tsd-signature-symbol">: </span><a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a><span class="tsd-signature-symbol"> | </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span>, cb<span class="tsd-signature-symbol">?: </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/client.html">Client</a>.<a href="../interfaces/client.html#queryfirst">queryFirst</a></p>
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L159">ResolvedApi.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve the document returned by the given query</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>q: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>optionsOrCallback: <a href="../interfaces/queryoptions.html" class="tsd-signature-type">QueryOptions</a><span class="tsd-signature-symbol"> | </span><a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="ref" class="tsd-anchor"></a>
<h3>ref</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">ref<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/ResolvedApi.ts#L113">ResolvedApi.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the ref ID for a given ref's label.
Do not use like this: searchForm.ref(api.ref("Future release label")).
Instead, set your ref once in a variable, and call it when you need it; this will allow to change the ref you