prismic-javascript
Version:
JavaScript development kit for prismic.io
508 lines • 36 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Client | 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="client.html">Client</a>
</li>
</ul>
<h1>Interface Client</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">Client</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/defaultclient.html" class="tsd-signature-type">DefaultClient</a></li>
<li><a href="../classes/resolvedapi.html" class="tsd-signature-type">ResolvedApi</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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#getbookmark" class="tsd-kind-icon">get<wbr>Bookmark</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#getbyid" class="tsd-kind-icon">get<wbr>ByID</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#getbyids" class="tsd-kind-icon">get<wbr>ByIDs</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#getbyuid" class="tsd-kind-icon">get<wbr>ByUID</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#getpreviewresolver" class="tsd-kind-icon">get<wbr>Preview<wbr>Resolver</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#getsingle" class="tsd-kind-icon">get<wbr>Single</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#previewsession" class="tsd-kind-icon">preview<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#query" class="tsd-kind-icon">query</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="client.html#queryfirst" class="tsd-kind-icon">query<wbr>First</a></li>
</ul>
</section>
</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-interface 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-interface 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>, options<span class="tsd-signature-symbol">: </span><a href="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L17">client.ts:17</a></li>
</ul>
</aside>
<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>options: <a href="queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5>cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="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="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-interface 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-interface 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>, options<span class="tsd-signature-symbol">: </span><a href="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L13">client.ts:13</a></li>
</ul>
</aside>
<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>options: <a href="queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5>cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="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="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-interface 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-interface 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>, options<span class="tsd-signature-symbol">: </span><a href="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L14">client.ts:14</a></li>
</ul>
</aside>
<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>options: <a href="queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5>cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="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="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-interface 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-interface 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>, options<span class="tsd-signature-symbol">: </span><a href="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L15">client.ts:15</a></li>
</ul>
</aside>
<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>options: <a href="queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5>cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="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="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-interface 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-interface 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="previewresolver.html" class="tsd-signature-type">PreviewResolver</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/client.ts#L18">client.ts:18</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="previewresolver.html" class="tsd-signature-type">PreviewResolver</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface 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-interface 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>, options<span class="tsd-signature-symbol">: </span><a href="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L16">client.ts:16</a></li>
</ul>
</aside>
<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>options: <a href="queryoptions.html" class="tsd-signature-type">QueryOptions</a></h5>
</li>
<li>
<h5>cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="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="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-interface 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-interface 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><span class="tsd-signature-type">function</span>, 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/client.ts#L19">client.ts:19</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: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>doc: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</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-interface tsd-is-external">
<a name="query" class="tsd-anchor"></a>
<h3>query</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface 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="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="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L11">client.ts:11</a></li>
</ul>
</aside>
<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="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="apisearchresponse.html" class="tsd-signature-type">ApiSearchResponse</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="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="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-interface 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-interface 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="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="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="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="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">
<ul>
<li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/client.ts#L12">client.ts:12</a></li>
</ul>
</aside>
<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="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="document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>cb: <a href="../globals.html#requestcallback" class="tsd-signature-type">RequestCallback</a><span class="tsd-signature-symbol"><</span><a href="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="document.html" class="tsd-signature-type">Document</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-is-external">
<a href="client.html" class="tsd-kind-icon">Client</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#getbookmark" class="tsd-kind-icon">get<wbr>Bookmark</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#getbyid" class="tsd-kind-icon">get<wbr>ByID</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#getbyids" class="tsd-kind-icon">get<wbr>ByIDs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#getbyuid" class="tsd-kind-icon">get<wbr>ByUID</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#getpreviewresolver" class="tsd-kind-icon">get<wbr>Preview<wbr>Resolver</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#getsingle" class="tsd-kind-icon">get<wbr>Single</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#previewsession" class="tsd-kind-icon">preview<wbr>Session</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#query" class="tsd-kind-icon">query</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="client.html#queryfirst" class="tsd-kind-icon">query<wbr>First</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>