UNPKG

prismic-javascript

Version:
803 lines 68 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Prismic | 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="prismic.html">Prismic</a> </li> </ul> <h1>Module Prismic</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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 "> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="prismic.html#api" class="tsd-kind-icon">Api</a></li> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="prismic.html#experiments" class="tsd-kind-icon">Experiments</a></li> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="prismic.html#predicates" class="tsd-kind-icon">Predicates</a></li> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="prismic.html#experimentcookie" class="tsd-kind-icon">experiment<wbr>Cookie</a></li> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="prismic.html#previewcookie" class="tsd-kind-icon">preview<wbr>Cookie</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-module"><a href="prismic.html#api-1" class="tsd-kind-icon">api</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="prismic.html#client" class="tsd-kind-icon">client</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="prismic.html#getapi" class="tsd-kind-icon">get<wbr>Api</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"> <a name="api" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Api</h3> <div class="tsd-signature tsd-kind-icon">Api<span class="tsd-signature-symbol">:</span> <a href="../classes/api.html" class="tsd-signature-type">Api</a><span class="tsd-signature-symbol"> =&nbsp;PrismicApi</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/index.ts#L13">index.ts:13</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"> <a name="experiments" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Experiments</h3> <div class="tsd-signature tsd-kind-icon">Experiments<span class="tsd-signature-symbol">:</span> <a href="../classes/experiments.html" class="tsd-signature-type">Experiments</a><span class="tsd-signature-symbol"> =&nbsp;PrismicExperiment</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/index.ts#L12">index.ts:12</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"> <a name="predicates" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Predicates</h3> <div class="tsd-signature tsd-kind-icon">Predicates<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> =&nbsp;PrismicPredicates</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/prismicio/prismic-javascript/blob/6155255/src/index.ts#L11">index.ts:11</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>after<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">after<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, after<span class="tsd-signature-symbol">: </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><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/Predicates.ts#L62">Predicates.ts:62</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>after: <a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>before<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">before<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, before<span class="tsd-signature-symbol">: </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><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/Predicates.ts#L58">Predicates.ts:58</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>before: <a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>between<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">between<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, before<span class="tsd-signature-symbol">: </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a>, after<span class="tsd-signature-symbol">: </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><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/Predicates.ts#L66">Predicates.ts:66</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>before: <a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a></h5> </li> <li> <h5>after: <a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>day<wbr>OfMonth<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">day<wbr>OfMonth<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, day<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L70">Predicates.ts:70</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>day: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>day<wbr>OfMonth<wbr>After<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">day<wbr>OfMonth<wbr>After<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, day<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L74">Predicates.ts:74</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>day: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>day<wbr>OfMonth<wbr>Before<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">day<wbr>OfMonth<wbr>Before<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, day<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L78">Predicates.ts:78</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>day: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>day<wbr>OfWeek<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">day<wbr>OfWeek<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, day<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><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/Predicates.ts#L82">Predicates.ts:82</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>day: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>day<wbr>OfWeek<wbr>After<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">day<wbr>OfWeek<wbr>After<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, day<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><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/Predicates.ts#L86">Predicates.ts:86</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>day: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>day<wbr>OfWeek<wbr>Before<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">day<wbr>OfWeek<wbr>Before<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, day<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><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/Predicates.ts#L90">Predicates.ts:90</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>day: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>hour<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">hour<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hour<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L110">Predicates.ts:110</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>hour: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>hour<wbr>After<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">hour<wbr>After<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hour<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L118">Predicates.ts:118</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>hour: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>hour<wbr>Before<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">hour<wbr>Before<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hour<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L114">Predicates.ts:114</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>hour: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>month<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">month<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, month<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><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/Predicates.ts#L94">Predicates.ts:94</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>month: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>month<wbr>After<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">month<wbr>After<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, month<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><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/Predicates.ts#L102">Predicates.ts:102</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>month: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>month<wbr>Before<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">month<wbr>Before<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, month<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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><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/Predicates.ts#L98">Predicates.ts:98</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>month: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>year<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">year<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, year<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L106">Predicates.ts:106</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>year: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>date<wbr>After<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.after" class="tsd-signature-type">after</a></h5> </li> <li class="tsd-parameter"> <h5>date<wbr>Before<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.before" class="tsd-signature-type">before</a></h5> </li> <li class="tsd-parameter"> <h5>date<wbr>Between<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.between" class="tsd-signature-type">between</a></h5> </li> <li class="tsd-parameter"> <h5>day<wbr>OfMonth<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.dayofmonth" class="tsd-signature-type">dayOfMonth</a></h5> </li> <li class="tsd-parameter"> <h5>day<wbr>OfMonth<wbr>After<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.dayofmonthafter" class="tsd-signature-type">dayOfMonthAfter</a></h5> </li> <li class="tsd-parameter"> <h5>day<wbr>OfMonth<wbr>Before<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.dayofmonthbefore" class="tsd-signature-type">dayOfMonthBefore</a></h5> </li> <li class="tsd-parameter"> <h5>day<wbr>OfWeek<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.dayofweek" class="tsd-signature-type">dayOfWeek</a></h5> </li> <li class="tsd-parameter"> <h5>day<wbr>OfWeek<wbr>After<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.dayofweekafter" class="tsd-signature-type">dayOfWeekAfter</a></h5> </li> <li class="tsd-parameter"> <h5>day<wbr>OfWeek<wbr>Before<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.dayofweekbefore" class="tsd-signature-type">dayOfWeekBefore</a></h5> </li> <li class="tsd-parameter"> <h5>geopoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>near<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">near<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, latitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, longitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, radius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L51">Predicates.ts:51</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>latitude: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>longitude: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>radius: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>gt<span class="tsd-signature-symbol">: </span><a href="../globals.html#number.gt" class="tsd-signature-type">gt</a></h5> </li> <li class="tsd-parameter"> <h5>hour<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.hour" class="tsd-signature-type">hour</a></h5> </li> <li class="tsd-parameter"> <h5>hour<wbr>After<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.hourafter" class="tsd-signature-type">hourAfter</a></h5> </li> <li class="tsd-parameter"> <h5>hour<wbr>Before<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.hourbefore" class="tsd-signature-type">hourBefore</a></h5> </li> <li class="tsd-parameter"> <h5>in<wbr>Range<span class="tsd-signature-symbol">: </span><a href="../globals.html#number.inrange" class="tsd-signature-type">inRange</a></h5> </li> <li class="tsd-parameter"> <h5>lt<span class="tsd-signature-symbol">: </span><a href="../globals.html#number.lt" class="tsd-signature-type">lt</a></h5> </li> <li class="tsd-parameter"> <h5>month<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.month" class="tsd-signature-type">month</a></h5> </li> <li class="tsd-parameter"> <h5>month<wbr>After<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.monthafter" class="tsd-signature-type">monthAfter</a></h5> </li> <li class="tsd-parameter"> <h5>month<wbr>Before<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.monthbefore" class="tsd-signature-type">monthBefore</a></h5> </li> <li class="tsd-parameter"> <h5>near<span class="tsd-signature-symbol">: </span><a href="../globals.html#geopoint.near" class="tsd-signature-type">near</a></h5> </li> <li class="tsd-parameter"> <h5>number<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>gt<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">gt<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L124">Predicates.ts:124</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>in<wbr>Range<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">in<wbr>Range<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, before<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, after<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L132">Predicates.ts:132</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>before: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>after: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>lt<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">lt<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Predicates.ts#L128">Predicates.ts:128</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>year<span class="tsd-signature-symbol">: </span><a href="../globals.html#date.year" class="tsd-signature-type">year</a></h5> </li> <li class="tsd-parameter"> <h5>any<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">any<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, values<span class="tsd-signature-symbol">: </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><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/Predicates.ts#L154">Predicates.ts:154</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>values: <a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>at<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">at<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><span class="tsd-signature-symbol"> | </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><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/Predicates.ts#L138">Predicates.ts:138</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>value: <a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><span class="tsd-signature-symbol"> | </span><a href="../globals.html#predicatevalue" class="tsd-signature-type">PredicateValue</a><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>fulltext<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">fulltext<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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></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/Predicates.ts#L162">Predicates.ts:162</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>value: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>has<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">has<span class="tsd-signature-symbol">(</span>fragment<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></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/Predicates.ts#L150">Predicates.ts:150</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>in<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">in<span class="tsd-signature-symbol">(</span>fragment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, values<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">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/Predicates.ts#L158">Predicates.ts:158</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fragment: <span class="tsd-signature-type">