prismic-javascript

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>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"> All <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> </ul> <h1> prismic-javascript</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <h2 id="javascript-development-for-prismic-io-api-v2">JavaScript development for prismic.io API v2</h2> <a href="http://badge.fury.io/js/prismic-javascript"><img src="https://badge.fury.io/js/prismic-javascript.svg" alt="npm version"></a> <a href="https://travis-ci.org/prismicio/prismic-javascript"><img src="https://api.travis-ci.org/prismicio/prismic-javascript.png" alt="Build Status"></a> <ul> <li>The <a href="https://github.com/prismicio/prismic-javascript">source code</a> is on Github.</li> <li>The <a href="https://github.com/prismicio/prismic-javascript/releases">Changelog</a> is on Github's releases tab.</li> <li>The <a href="https://prismicio.github.io/prismic-javascript/globals.html">API reference</a> is on Github.</li> </ul> It's meant to work in pair with the prismic-dom library available here: <ul> <li><a href="https://github.com/prismicio/prismic-dom">prismic-dom</a> is on Github.</li> </ul> <hr> <h2 id="1-installation"><a href="#installation">1. Installation</a></h2> <blockquote> <a href="#prismic-api-settings">Prismic API Settings</a> <a href="#npm">NPM</a> <a href="#cdn">CDN</a> <a href="#downloadable-version">Downloadable version</a> <a href="#demo-project">Demo project</a> <a href="#starter-kits">Starter kits</a> </blockquote> <h2 id="2-query-the-content"><a href="#query-the-content">2. Query the content</a></h2> <h2 id="3-integrate-the-content"><a href="#integrate-the-content">3. Integrate the content</a></h2> <blockquote> <a href="#embed">Embed</a> <a href="#image">Image</a> <a href="#text">Text</a> <a href="#number">Number</a> <a href="#date">Date</a> <a href="#timestamp">Timestamp</a> <a href="#select">Select</a> <a href="#color">Color</a> <a href="#structuredText">StructuredText</a> <a href="#weblink">WebLink</a> <a href="#documentlink">DocumentLink</a> <a href="#imagelink">ImageLink</a> <a href="#filelink">FileLink</a> <a href="#separator">Separator</a> <a href="#group">Group</a> <a href="#geopoint">GeoPoint</a> <a href="#slices">Slices</a> </blockquote> <h2 id="4-contribute-to-the-kit"><a href="#contribute-to-the-kit">4. Contribute to the kit</a></h2> <blockquote> <a href="#install-the-kit-locally">Install the kit locally</a> <a href="#documentation">Documentation</a> </blockquote> <h2 id="5-license"><a href="#license">5. License</a></h2> <hr> <h3 id="installation">Installation</h3> <h4 id="prismic-api-settings">Prismic API Settings</h4> Your endpoint must contains "v2" at the end, otherwise it means that you're working on the API V1 so this library won't work for you. <pre><code class="language-javascript">apiEndpoint: your-repo-name.prismic.io/api/v2</code></pre> <h4 id="npm">NPM</h4> <pre><code class="language-sh">npm install prismic-javascript --save</code></pre> <h4 id="cdn">CDN</h4> <pre><code>https://unpkg.com/prismic-javascript</code></pre>(You may need to adapt the version number) <h4 id="downloadable-version">Downloadable version</h4> On our release page: <a href="https://github.com/prismicio/prismic-javascript/releases">https://github.com/prismicio/prismic-javascript/releases</a>. The kit is universal, it can be used: <ul> <li>Server-side with NodeJS</li> <li>Client-side as part of your build with Browserify, Webpack</li> <li>Client-side with a simple script tag</li> </ul> <h4 id="starter-kits">Starter kits</h4> For new project, you can start from a sample project: <ul> <li><a href="https://github.com/prismicio/nodejs-sdk">Node.js project</a></li> <li><a href="https://github.com/prismicio/nodejs-blog">Node.js blog</a></li> </ul> <h4 id="demo-project">Demo project</h4> You can find an integration of prismic content with the new API V2 in the following project: <ul> <li><a href="https://github.com/arnaudlewis/prismic-apiv2">Node.js project</a></li> </ul> <h3 id="query-the-content">Query the content</h3> To fetch documents from your repository, you need to fetch the Api data first. <pre><code class="language-javascript">var Prismic = require('prismic-javascript'); Prismic.api("http://your_repository_name.prismic.io/api", function(error, api) { var options = {}; // In Node.js, pass the request as 'req' to read the reference from the cookies api.query("", options, function(err, response) { // An empty query will return all the documents if (err) { console.log("Something went wrong: ", err); } console.log("Documents: ", response.documents); }); });</code></pre> All asynchronous calls return ES2015 promises, so alternatively you can use them instead of callbacks. <pre><code class="language-javascript">var Prismic = require('prismic-javascript'); Prismic.api("https://your-repository-name.prismic.io/api").then(function(api) { return api.query(""); // An empty query will return all the documents }).then(function(response) { console.log("Documents: ", response.results); }, function(err) { console.log("Something went wrong: ", err); });</code></pre> If you included prismic through the script tag (CDN) there is a global variable PrismicJS: <pre><code class="language-javascript">PrismicJS.api("https://your-repository-name.prismic.io/api").then( api => { const faq = PrismicJS.Predicates.at('document.type', 'faq'); api.query(faq, { lang: 'en-en' }).then( response => { console.log("Documents: ", response.results); }) })</code></pre> See the <a href="https://prismic.io/docs">developer documentation</a> or the <a href="https://prismicio.github.io/prismic-javascript/globals.html">API documentation</a> for more details on how to use it. <h3 id="integrate-the-content">Integrate the content</h3> In each case documented below, you will have a snippet of the custom type and another for the code needed to fill the content field into your JS Template. In these examples we have a <code>doc</code> parameter corresponding to the fetched prismic document. <h4 id="embed">Embed</h4> Custom type <pre><code class="language-javascript">"video" : { "type" : "Embed" }</code></pre> Template JS <pre><code class="language-javascript">doc.data.video.embed_url</code></pre> <h4 id="image">Image</h4> Custom type <pre><code class="language-javascript">"photo" : { "type" : "Image", "fieldset" : "Image", "config" : { "constraint" : { "width" : 300, "height" : 300 }, "thumbnails" : [ { "name" : "Small", "width" : 100, "height" : 100 }, { "name" : "Medium", "width" : 200, "height" : 200 }, { "name" : "Large", "width" : 300, "height" : 300 } ] } }</code></pre> Template JS <pre><code class="language-javascript">//main view doc.data.photo.url doc.data.photo.alt doc.data.photo.width doc.data.photo.height //thumbnails => example for small view doc.data.photo.small.url doc.data.photo.small.alt doc.data.photo.small.width doc.data.photo.small.height</code></pre> <h4 id="text">Text</h4> Custom type <pre><code class="language-javascript">"title" : { "type" : "Text", }</code></pre> Template JS <pre><code class="language-javascript">doc.data.title</code></pre> <h4 id="number">Number</h4> Custom type <pre><code class="language-javascript">"count" : { "type" : "Text", }</code></pre> Template JS <pre><code class="language-javascript">doc.data.count</code></pre> <h4 id="date">Date</h4> Custom type <pre><code class="language-javascript">"publication" : { "type" : "Date", }</code></pre> Template JS <pre><code class="language-javascript">import { Date } from 'prismic-dom' // date as string from the API doc.data.publication // date as JS Date Date(doc.data.publication) </code></pre> <h4 id="timestamp">Timestamp</h4> Custom type <pre><code class="language-javascript">"time" : { "type" : "Timestamp", }</code></pre> Template JS <pre><code class="language-javascript">import { Date } from 'prismic-dom' // timestamp as string from the API doc.data.time // timestamp as JS Datetime Date(doc.data.time)</code></pre> <h4 id="select">Select</h4> Custom type <pre><code class="language-javascript">"gender" : { "type" : "Select", }</code></pre> Template JS <pre><code class="language-javascript">doc.data.gender</code></pre> <h4 id="color">Color</h4> Custom type <pre><code class="language-javascript">"background" : { "type" : "Color", }</code></pre> Template JS <pre><code class="language-javascript">doc.data.background</code></pre> <h4 id="richtext">RichText</h4> Custom type <pre><code class="language-javascript">"description" : { "type" : "StructuredText", }</code></pre> Template JS <pre><code class="language-javascript">import { RichText } from 'prismic-dom' RichText.asText(doc.data.description) //linkResolver must be declare somewhere RichText.asHtml(doc.data.description, linkResolver)</code></pre> <h4 id="weblink">WebLink</h4> Custom type <pre><code class="language-javascript">"linktoweb" : { "type" : "Link", "config" : { "select" : "web" } }</code></pre> Template JS <pre><code class="language-javascript">doc.data.linktoweb.url</code></pre> <h4 id="documentlink">DocumentLink</h4> Custom type <pre><code class="language-javascript">"linktodoc" : { "type" : "Link", "config" : { "select" : "document", "customtypes" : [ <your-custom-type-id> ], "tags" : [ <your-tag> ], } }</code></pre> Template JS <pre><code class="language-javascript">//return url of the document link doc.data.linktodoc //return url of the document linkResolver(doc.data.linktodoc)</code></pre> <h4 id="imagelink">ImageLink</h4> Custom type <pre><code class="language-javascript">"linktomedia" : { "type" : "Link", "config" : { "select" : "media" } }</code></pre> Template JS <pre><code class="language-javascript">doc.data.linktomedia.url</code></pre> <h4 id="filelink">FileLink</h4> Custom type <pre><code class="language-javascript">"linktofile" : { "type" : "Link", "config" : { "select" : "media" } }</code></pre> Template JS <pre><code class="language-javascript">doc.data.linktofile.url</code></pre> <h4 id="group">Group</h4> Custom type <pre><code class="language-javascript">"feature" : { "type" : "Group", "repeat": true, //default to true but put explicitly for the example "config" : { "field" : { "title" : { "type" : "Text", }, "description" : { "type" : "StructuredText", } } } }</code></pre> Template JS <pre><code class="language-javascript">import { RichText } from 'prismic-dom' doc.data.feature.forEach(item => { item.title RichText.asHtml(item.description, linkResolver) })</code></pre> <h4 id="geopoint">GeoPoint</h4> Custom type <pre><code class="language-javascript">"location" : { "type" : "GeoPoint", }</code></pre> Template JS <pre><code class="language-javascript">doc.data.latitude doc.data.longitude</code></pre> <h4 id="slices">Slices</h4> Slice with Group as value The Group value will be put directly as Slice value Custom type <pre><code class="language-javascript">"contentAsSlices" : { "fieldset" : "Dynamic page zone...", "type" : "Slices", "config" : { "choices" : { "slides" : { "type" : "Group", //required to display name in slice select in the writing room "fieldset" : "Slides", "config" : { "fields" : { "illustration" : { "type" : "Image" }, "title" : { "type" : "StructuredText" } } } } } } }</code></pre> Template JS <pre><code class="language-javascript">for(slice in doc.data.contentAsSlices) { switch(slice.slice_type) { case 'slides': slice.value.forEach(item => { item.illustration.url item.title }) break } } </code></pre> Slice with basic fragment like Text as value The fragment value will be put directly as Slice value Custom type <pre><code class="language-javascript">"contentAsSlices" : { "fieldset" : "Dynamic page zone...", "type" : "Slices", "config" : { "choices" : { "description" : { "type" : "StructuredText" } } } }</code></pre> Template JS <pre><code class="language-javascript">import { RichText } from 'prismic-dom' for(slice in doc.contentAsSlices) { switch(slice.slice_type) { case 'description': RichText.asHtml(slice.value, linkResolver) break } } </code></pre> new Slice the new Slice type allow you to create a repeatable area and a non repeatable one. <pre><code class="language-javascript">"contentAsSlices" : { "fieldset" : "Dynamic page zone...", "type" : "Slices", "config" : { "choices" : { "newslice" : { "type" : "Slice", "non-repeat": { "title": { "type": "Text" } }, "repeat": { "description": { "type" : "StructuredText" } } } } } }</code></pre> Template JS <pre><code class="language-javascript">import { RichText } from 'prismic-dom' for(slice in doc.contentAsSlices) { switch(slice.slice_type) { case 'newslice': //non repeatable part slice.value.primary.title //repeatable part slice.value.items.forEach(item => { RichText.asHtml(item.description, linkResolver) }) break } } </code></pre> <h3 id="contribute-to-the-kit">Contribute to the kit</h3> <h4 id="install-the-kit-locally">Install the kit locally</h4> Source files are in the <code>src/</code> directory. You only need <a href="http://www.joyent.com/blog/installing-node-and-npm/">Node.js and npm</a> to work on the codebase. <pre><code class="language-bash">npm install npm run dev</code></pre> <h4 id="documentation">Documentation</h4> Please document any new feature or bugfix using the <a href="http://usejsdoc.org/">JSDoc</a> syntax. You don't need to generate the documentation, we'll do that. If you feel an existing area of code is lacking documentation, feel free to write it; but please do so on its own branch and pull-request. If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request. <h3 id="license">License</h3> This software is licensed under the Apache 2 license, quoted below. Copyright 2013-2017 Prismic.io (<a href="http://prismic.io)">http://prismic.io)</a>. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. </div> </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">Globals</a> </li> <li class=" tsd-kind-module"> <a href="modules/prismic.html">Prismic</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/api.html" class="tsd-kind-icon">Api</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/defaultapicache.html" class="tsd-kind-icon">DefaultApiCache</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/defaultclient.html" class="tsd-kind-icon">DefaultClient</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/defaultrequesthandler.html" class="tsd-kind-icon">DefaultRequestHandler</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/experiment.html" class="tsd-kind-icon">Experiment</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/experiments.html" class="tsd-kind-icon">Experiments</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/httpclient.html" class="tsd-kind-icon">HttpClient</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/lazysearchform.html" class="tsd-kind-icon">LazySearchForm</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/resolvedapi.html" class="tsd-kind-icon">ResolvedApi</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/searchform.html" class="tsd-kind-icon">SearchForm</a> </li> <li class=" tsd-kind-class tsd-is-external"> <a href="classes/variation.html" class="tsd-kind-icon">Variation</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/alternatelanguage.html" class="tsd-kind-icon">AlternateLanguage</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/apicache.html" class="tsd-kind-icon">ApiCache</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/apidata.html" class="tsd-kind-icon">ApiData</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/apioptions.html" class="tsd-kind-icon">ApiOptions</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/apisearchresponse.html" class="tsd-kind-icon">ApiSearchResponse</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/client.html" class="tsd-kind-icon">Client</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/cookie.html" class="tsd-kind-icon">Cookie</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/document.html" class="tsd-kind-icon">Document</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/form.html" class="tsd-kind-icon">Form</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/httpclientoptions.html" class="tsd-kind-icon">HttpClientOptions</a> </li> <li class=" tsd-kind-interface tsd-is-external tsd-is-not-exported"> <a href="interfaces/ientry.html" class="tsd-kind-icon">IEntry</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/ilrucache.html" class="tsd-kind-icon">ILRUCache</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/language.html" class="tsd-kind-icon">Language</a> </li> <li class=" tsd-kind-interface tsd-is-external tsd-is-not-exported"> <a href="interfaces/noderequestinit.html" class="tsd-kind-icon">NodeRequestInit</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/previewresolver.html" class="tsd-kind-icon">PreviewResolver</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/previewresponse.html" class="tsd-kind-icon">PreviewResponse</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/queryoptions.html" class="tsd-kind-icon">QueryOptions</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/ref.html" class="tsd-kind-icon">Ref</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/requesthandler.html" class="tsd-kind-icon">RequestHandler</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/requesthandleroption.html" class="tsd-kind-icon">RequestHandlerOption</a> </li> <li class=" tsd-kind-interface tsd-is-external"> <a href="interfaces/resolvedapioptions.html" class="tsd-kind-icon">ResolvedApiOptions</a> </li> <li class=" tsd-kind-type-alias tsd-is-external"> <a href="globals.html#fields" class="tsd-kind-icon">Fields</a> </li> <li class=" tsd-kind-type-alias tsd-is-external"> <a href="globals.html#linkresolver" class="tsd-kind-icon">LinkResolver</a> </li> <li class=" tsd-kind-type-alias tsd-is-external tsd-is-not-exported"> <a href="globals.html#predicatevalue" class="tsd-kind-icon">PredicateValue</a> </li> <li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-external"> <a href="globals.html#requestcallback" class="tsd-kind-icon">RequestCallback</a> </li> <li class=" tsd-kind-variable tsd-is-external"> <a href="globals.html#experiment_cookie" class="tsd-kind-icon">EXPERIMENT_COOKIE</a> </li> <li class=" tsd-kind-variable tsd-is-external"> <a href="globals.html#preview_cookie" class="tsd-kind-icon">PREVIEW_COOKIE</a> </li> <li class=" tsd-kind-variable tsd-is-external tsd-is-not-exported"> <a href="globals.html#decode" class="tsd-kind-icon">decode</a> </li> <li class=" tsd-kind-function tsd-is-external tsd-is-not-exported"> <a href="globals.html#lrucache" class="tsd-kind-icon">LRUCache</a> </li> <li class=" tsd-kind-function tsd-is-external"> <a href="globals.html#makelrucache" class="tsd-kind-icon">MakeLRUCache</a> </li> <li class=" tsd-kind-function tsd-is-external"> <a href="globals.html#createpreviewresolver" class="tsd-kind-icon">createPreviewResolver</a> </li> <li class=" tsd-kind-function tsd-is-external tsd-is-not-exported"> <a href="globals.html#encode" class="tsd-kind-icon">encode</a> </li> <li class=" tsd-kind-function tsd-has-type-parameter tsd-is-external tsd-is-not-exported"> <a href="globals.html#fetchrequest" class="tsd-kind-icon">fetchRequest</a> </li> <li class=" tsd-kind-function tsd-is-external tsd-is-not-exported"> <a href="globals.html#parse" class="tsd-kind-icon">parse</a> </li> <li class=" tsd-kind-function tsd-is-external tsd-is-not-exported"> <a href="globals.html#separator" class="tsd-kind-icon">separator</a> </li> <li class=" tsd-kind-function tsd-is-external tsd-is-not-exported"> <a href="globals.html#trydecode" class="tsd-kind-icon">tryDecode</a> </li> <li class=" tsd-kind-object-literal tsd-is-external tsd-is-not-exported"> <a href="globals.html#operator" class="tsd-kind-icon">OPERATOR</a> </li> <li class=" tsd-kind-object-literal tsd-is-external tsd-is-not-exported"> <a href="globals.html#date" class="tsd-kind-icon">date</a> </li> <li class=" tsd-kind-object-literal tsd-is-external tsd-is-not-exported"> <a href="globals.html#geopoint" class="tsd-kind-icon">geopoint</a> </li> <li class=" tsd-kind-object-literal tsd-is-external tsd-is-not-exported"> <a href="globals.html#number" class="tsd-kind-icon">number</a> </li> </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">Module</li> <li class="tsd-kind-object-literal">Object literal</li> <li class="tsd-kind-variable">Variable</li> <li class="tsd-kind-function">Function</li> <li class="tsd-kind-function tsd-has-type-parameter">Function with type parameter</li> <li class="tsd-kind-index-signature">Index signature</li> <li class="tsd-kind-type-alias">Type alias</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum">Enumeration</li> <li class="tsd-kind-enum-member">Enumeration member</li> <li class="tsd-kind-property tsd-parent-kind-enum">Property</li> <li class="tsd-kind-method tsd-parent-kind-enum">Method</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface">Interface</li> <li class="tsd-kind-interface tsd-has-type-parameter">Interface with type parameter</li> <li class="tsd-kind-constructor tsd-parent-kind-interface">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-interface">Property</li> <li class="tsd-kind-method tsd-parent-kind-interface">Method</li> <li class="tsd-kind-index-signature tsd-parent-kind-interface">Index signature</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class">Class</li> <li class="tsd-kind-class tsd-has-type-parameter">Class with type parameter</li> <li class="tsd-kind-constructor tsd-parent-kind-class">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-class">Property</li> <li class="tsd-kind-method tsd-parent-kind-class">Method</li> <li class="tsd-kind-accessor tsd-parent-kind-class">Accessor</li> <li class="tsd-kind-index-signature tsd-parent-kind-class">Index signature</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">Inherited constructor</li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited">Inherited property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited">Inherited method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">Inherited accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected">Protected property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected">Protected method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected">Protected accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private">Private property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private">Private method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private">Private accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static">Static property</li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static">Static method</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a> </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>