Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
851 lines (850 sloc) 51 KB
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>vanilla | @uirouter/core</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/uirouter.css">
<script src="../assets/js/modernizr.js"></script>
<script src="../assets/js/reset.js"></script>
</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">@uirouter/core</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">Internal UI-Router API</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="../index.html">@uirouter/core</a>
</li>
<li>
<a href="vanilla.html">vanilla</a>
</li>
</ul>
<h1>Module vanilla</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/vanilla.baselocationservices.html" class="tsd-kind-icon">Base<wbr>Location<wbr>Services</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/vanilla.browserlocationconfig.html" class="tsd-kind-icon">Browser<wbr>Location<wbr>Config</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/vanilla.hashlocationservice.html" class="tsd-kind-icon">Hash<wbr>Location<wbr>Service</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/vanilla.memorylocationconfig.html" class="tsd-kind-icon">Memory<wbr>Location<wbr>Config</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/vanilla.memorylocationservice.html" class="tsd-kind-icon">Memory<wbr>Location<wbr>Service</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/vanilla.pushstatelocationservice.html" class="tsd-kind-icon">Push<wbr>State<wbr>Location<wbr>Service</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"><a href="../interfaces/vanilla.historylike.html" class="tsd-kind-icon">History<wbr>Like</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"><a href="../interfaces/vanilla.locationlike.html" class="tsd-kind-icon">Location<wbr>Like</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"><a href="../interfaces/vanilla.locationplugin.html" class="tsd-kind-icon">Location<wbr>Plugin</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"><a href="../interfaces/vanilla.servicesplugin.html" class="tsd-kind-icon">Services<wbr>Plugin</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#_injector" class="tsd-kind-icon">$injector</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#_q" class="tsd-kind-icon">$q</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"><a href="vanilla.html#argument_names" class="tsd-kind-icon">ARGUMENT_<wbr>NAMES</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"><a href="vanilla.html#strip_comments" class="tsd-kind-icon">STRIP_<wbr>COMMENTS</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported"><a href="vanilla.html#globals" class="tsd-kind-icon">globals</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#hashlocationplugin" class="tsd-kind-icon">hash<wbr>Location<wbr>Plugin</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#memorylocationplugin" class="tsd-kind-icon">memory<wbr>Location<wbr>Plugin</a></li>
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#pushstatelocationplugin" class="tsd-kind-icon">push<wbr>State<wbr>Location<wbr>Plugin</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#buildurl" class="tsd-kind-icon">build<wbr>Url</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#getparams" class="tsd-kind-icon">get<wbr>Params</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#keyvalstoobjectr" class="tsd-kind-icon">key<wbr>Vals<wbr>ToObjectR</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#locationpluginfactory" class="tsd-kind-icon">location<wbr>Plugin<wbr>Factory</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#parseurl" class="tsd-kind-icon">parse<wbr>Url</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="vanilla.html#servicesplugin-1" class="tsd-kind-icon">services<wbr>Plugin</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a name="_injector" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> $injector</h3>
-->
<div class="tsd-signature tsd-kind-icon">$injector<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;{/** Gets an object from DI based on a string token */get: name &#x3D;&gt; globals[name],/** Returns true if an object named &#x60;name&#x60; exists in global DI */has: name &#x3D;&gt; $injector.get(name) !&#x3D; null,/*** Injects a function** @param fn the function to inject* @param context the function&#x27;s &#x60;this&#x60; binding* @param locals An object with additional DI tokens and values, such as &#x60;{ someToken: { foo: 1 } }&#x60;*/invoke: (fn: IInjectable, context?, locals?) &#x3D;&gt; {const all &#x3D; extend({}, globals, locals || {});const params &#x3D; $injector.annotate(fn);const ensureExist &#x3D; assertPredicate((key: string) &#x3D;&gt; all.hasOwnProperty(key),key &#x3D;&gt; &#x60;DI can&#x27;t find injectable: &#x27;${key}&#x27;&#x60;);const args &#x3D; params.filter(ensureExist).map(x &#x3D;&gt; all[x]);if (isFunction(fn)) return fn.apply(context, args);else return (fn as any[]).slice(-1)[0].apply(context, args);},/*** Returns a function&#x27;s dependencies** Analyzes a function (or array) and returns an array of DI tokens that the function requires.* @return an array of &#x60;string&#x60;s*/annotate: (fn: IInjectable): any[] &#x3D;&gt; {if (!isInjectable(fn)) throw new Error(&#x60;Not an injectable function: ${fn}&#x60;);if (fn &amp;&amp; (fn as any).$inject) return (fn as any).$inject;if (isArray(fn)) return fn.slice(0, -1);const fnStr &#x3D; fn.toString().replace(STRIP_COMMENTS, &#x27;&#x27;);const result &#x3D; fnStr.slice(fnStr.indexOf(&#x27;(&#x27;) + 1, fnStr.indexOf(&#x27;)&#x27;)).match(ARGUMENT_NAMES);return result || [];},} as $InjectorLike</span> <div class="tsd-header">
<p> A basic angular1-like injector api </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A basic angular1-like injector api</p>
</div>
<p>This object implements four methods similar to the
<a href="https://docs.angularjs.org/api/auto/service/$injector">angular 1 dependency injector</a></p>
<p>UI-Router evolved from an angular 1 library to a framework agnostic library.
However, some of the <code>@uirouter/core</code> code uses these ng1 style APIs to support ng1 style dependency injection.</p>
<p>This object provides a naive implementation of a globally scoped dependency injection system.
It supports the following DI approaches:</p>
<h3 id="function-parameter-names">Function parameter names</h3>
<p>A function&#39;s <code>.toString()</code> is called, and the parameter names are parsed.
This only works when the parameter names aren&#39;t &quot;mangled&quot; by a minifier such as UglifyJS.</p>
<pre><code class="language-js"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">injectedFunction</span>(<span class="hljs-params">FooService, BarService</span>) </span>{
<span class="hljs-comment">// FooService and BarService are injected</span>
}</code></pre>
<h3 id="function-annotation">Function annotation</h3>
<p>A function may be annotated with an array of dependency names as the <code>$inject</code> property.</p>
<pre><code class="language-js">injectedFunction.$inject = [ <span class="hljs-string">'FooService'</span>, <span class="hljs-string">'BarService'</span> ];
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">injectedFunction</span>(<span class="hljs-params">fs, bs</span>) </span>{
<span class="hljs-comment">// FooService and BarService are injected as fs and bs parameters</span>
}</code></pre>
<h3 id="array-notation">Array notation</h3>
<p>An array provides the names of the dependencies to inject (as strings).
The function is the last element of the array.</p>
<pre><code class="language-js">[ <span class="hljs-string">'FooService'</span>, <span class="hljs-string">'BarService'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">fs, bs</span>) </span>{
<span class="hljs-comment">// FooService and BarService are injected as fs and bs parameters</span>
}]</code></pre>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{$InjectorLike}</p>
</dd>
</dl>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/injector.ts#L64">vanilla/injector.ts:64</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a name="_q" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> $q</h3>
-->
<div class="tsd-signature tsd-kind-icon">$q<span class="tsd-signature-symbol">:</span> <a href="../interfaces/common._qlike.html" class="tsd-signature-type">$QLike</a><span class="tsd-signature-symbol"> =&nbsp;{/** Normalizes a value as a promise */when: val &#x3D;&gt; new Promise((resolve, reject) &#x3D;&gt; resolve(val)),/** Normalizes a value as a promise rejection */reject: val &#x3D;&gt;new Promise((resolve, reject) &#x3D;&gt; {reject(val);}),/** @returns a deferred object, which has &#x60;resolve&#x60; and &#x60;reject&#x60; functions */defer: () &#x3D;&gt; {const deferred: any &#x3D; {};deferred.promise &#x3D; new Promise((resolve, reject) &#x3D;&gt; {deferred.resolve &#x3D; resolve;deferred.reject &#x3D; reject;});return deferred;},/** Like Promise.all(), but also supports object key/promise notation like $q */all: (promises: { [key: string]: Promise&lt;any&gt; } | Promise&lt;any&gt;[]) &#x3D;&gt; {if (isArray(promises)) {return Promise.all(promises);}if (isObject(promises)) {// Convert promises map to promises array.// When each promise resolves, map it to a tuple { key: key, val: val }const chain &#x3D; Object.keys(promises).map(key &#x3D;&gt; promises[key].then(val &#x3D;&gt; ({ key, val })));// Then wait for all promises to resolve, and convert them back to an objectreturn $q.all(chain).then(values &#x3D;&gt;values.reduce((acc, tuple) &#x3D;&gt; {acc[tuple.key] &#x3D; tuple.val;return acc;}, {}));}},} as $QLike</span> <div class="tsd-header">
<p> An angular1-like promise api </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An angular1-like promise api</p>
</div>
<p>This object implements four methods similar to the
<a href="https://docs.angularjs.org/api/ng/service/$q">angular 1 promise api</a></p>
<p>UI-Router evolved from an angular 1 library to a framework agnostic library.
However, some of the <code>@uirouter/core</code> code uses these ng1 style APIs to support ng1 style dependency injection.</p>
<p>This API provides native ES6 promise support wrapped as a $q-like API.
Internally, UI-Router uses this $q object to perform promise operations.
The <code>angular-ui-router</code> (ui-router for angular 1) uses the $q API provided by angular.</p>
<p>$q-like promise api</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/q.ts#L19">vanilla/q.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a name="argument_names" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> ARGUMENT_<wbr>NAMES</h3>
-->
<div class="tsd-signature tsd-kind-icon">ARGUMENT_<wbr>NAMES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> =&nbsp;/([^\s,]+)/g</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/injector.ts#L15">vanilla/injector.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a name="strip_comments" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> STRIP_<wbr>COMMENTS</h3>
-->
<div class="tsd-signature tsd-kind-icon">STRIP_<wbr>COMMENTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> =&nbsp;/((\/\/.*$)|(\/\*[\s\S]*?\*\/))/gm</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/injector.ts#L14">vanilla/injector.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a name="globals" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> globals</h3>
-->
<div class="tsd-signature tsd-kind-icon">globals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<div class="tsd-declaration">
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/injector.ts#L13">vanilla/injector.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a name="hashlocationplugin" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> hash<wbr>Location<wbr>Plugin</h3>
-->
<div class="tsd-signature tsd-kind-icon">hash<wbr>Location<wbr>Plugin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> =&nbsp;locationPluginFactory(&#x27;vanilla.hashBangLocation&#x27;,false,HashLocationService,BrowserLocationConfig)</span> <div class="tsd-header">
<p> A <code>UIRouterPlugin</code> uses the browser hash to get/set the current location </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A <code>UIRouterPlugin</code> uses the browser hash to get/set the current location</p>
</div>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>router<span class="tsd-signature-symbol">: </span><a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vanilla.locationplugin.html" class="tsd-signature-type">LocationPlugin</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>router <a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/vanilla.locationplugin.html" class="tsd-signature-type">LocationPlugin</a></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/plugins.ts#L22">vanilla/plugins.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a name="memorylocationplugin" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> memory<wbr>Location<wbr>Plugin</h3>
-->
<div class="tsd-signature tsd-kind-icon">memory<wbr>Location<wbr>Plugin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> =&nbsp;locationPluginFactory(&#x27;vanilla.memoryLocation&#x27;,false,MemoryLocationService,MemoryLocationConfig)</span> <div class="tsd-header">
<p> A <code>UIRouterPlugin</code> that gets/sets the current location from an in-memory object </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A <code>UIRouterPlugin</code> that gets/sets the current location from an in-memory object</p>
</div>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>router<span class="tsd-signature-symbol">: </span><a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vanilla.locationplugin.html" class="tsd-signature-type">LocationPlugin</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>router <a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/vanilla.locationplugin.html" class="tsd-signature-type">LocationPlugin</a></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/plugins.ts#L38">vanilla/plugins.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a name="pushstatelocationplugin" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> push<wbr>State<wbr>Location<wbr>Plugin</h3>
-->
<div class="tsd-signature tsd-kind-icon">push<wbr>State<wbr>Location<wbr>Plugin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> =&nbsp;locationPluginFactory(&#x27;vanilla.pushStateLocation&#x27;,true,PushStateLocationService,BrowserLocationConfig)</span> <div class="tsd-header">
<p> A <code>UIRouterPlugin</code> that gets/sets the current location using the browser&#39;s <code>location</code> and <code>history</code> apis </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A <code>UIRouterPlugin</code> that gets/sets the current location using the browser&#39;s <code>location</code> and <code>history</code> apis</p>
</div>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>router<span class="tsd-signature-symbol">: </span><a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vanilla.locationplugin.html" class="tsd-signature-type">LocationPlugin</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>router <a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/vanilla.locationplugin.html" class="tsd-signature-type">LocationPlugin</a></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/plugins.ts#L30">vanilla/plugins.ts:30</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="buildurl" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> build<wbr>Url</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">build<wbr>Url<span class="tsd-signature-symbol">(</span>loc<span class="tsd-signature-symbol">: </span><a href="../interfaces/common.locationservices.html" class="tsd-signature-type">LocationServices</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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>loc <a href="../interfaces/common.locationservices.html" class="tsd-signature-type">LocationServices</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L40">vanilla/utils.ts:40</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="getparams" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Params</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>Params<span class="tsd-signature-symbol">(</span>queryString<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">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>queryString <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L25">vanilla/utils.ts:25</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="keyvalstoobjectr" class="tsd-anchor"></a>
<!--
<h3><span class="tsd-flag ts-flagConst">Const</span> key<wbr>Vals<wbr>ToObjectR</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">key<wbr>Vals<wbr>ToObjectR<span class="tsd-signature-symbol">(</span>accum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, __namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><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-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>accum <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>__namedParameters <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">]</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L14">vanilla/utils.ts:14</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="locationpluginfactory" class="tsd-anchor"></a>
<!--
<h3>location<wbr>Plugin<wbr>Factory</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">location<wbr>Plugin<wbr>Factory<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, isHtml5<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, serviceClass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, configurationClass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>isHtml5 <span class="tsd-signature-type">boolean</span></h5>
</li>
<li>
<h5>serviceClass <span class="tsd-signature-type">object</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>constructor<span class="tsd-signature-symbol">: </span>function</h5>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-type-literal tsd-is-external tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">new __type<span class="tsd-signature-symbol">(</span>uiRouter<span class="tsd-signature-symbol">?: </span><a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/common.locationservices.html" class="tsd-signature-type">LocationServices</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uiRouter: <span class="tsd-flag ts-flagOptional">Optional</span>&nbsp; <a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/common.locationservices.html" class="tsd-signature-type">LocationServices</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L60">vanilla/utils.ts:60</a></li>
</ul>
</aside> </li>
</ul>
</li>
</ul>
</li>
<li>
<h5>configurationClass <span class="tsd-signature-type">object</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>constructor<span class="tsd-signature-symbol">: </span>function</h5>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-type-literal tsd-is-external tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">new __type<span class="tsd-signature-symbol">(</span>uiRouter<span class="tsd-signature-symbol">?: </span><a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a>, isHtml5<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/common.locationconfig.html" class="tsd-signature-type">LocationConfig</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uiRouter: <span class="tsd-flag ts-flagOptional">Optional</span>&nbsp; <a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
<li>
<h5>isHtml5: <span class="tsd-flag ts-flagOptional">Optional</span>&nbsp; <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/common.locationconfig.html" class="tsd-signature-type">LocationConfig</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L61">vanilla/utils.ts:61</a></li>
</ul>
</aside> </li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L57">vanilla/utils.ts:57</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="parseurl" class="tsd-anchor"></a>
<!--
<h3>parse<wbr>Url</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Url<span class="tsd-signature-symbol">(</span>url<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">object</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>search<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
<li class="tsd-parameter">
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/utils.ts#L32">vanilla/utils.ts:32</a></li>
</ul>
</aside> </li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a name="servicesplugin-1" class="tsd-anchor"></a>
<!--
<h3>services<wbr>Plugin</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<li class="tsd-signature tsd-kind-icon">services<wbr>Plugin<span class="tsd-signature-symbol">(</span>router<span class="tsd-signature-symbol">: </span><a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vanilla.servicesplugin.html" class="tsd-signature-type">ServicesPlugin</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>router <a href="../classes/core.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/vanilla.servicesplugin.html" class="tsd-signature-type">ServicesPlugin</a></h4>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/d7fcc8f/src/vanilla/plugins.ts#L14">vanilla/plugins.ts:14</a></li>
</ul>
</aside> </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="../index.html"><em>@uirouter/core</em></a>
</li>
<li class="label tsd-is-external">
<span>Public API</span>
</li>
<li class=" tsd-kind-external-module">
<a href="common.html">common</a>
</li>
<li class=" tsd-kind-external-module">
<a href="core.html">core</a>
</li>
<li class=" tsd-kind-external-module">
<a href="params.html">params</a>
</li>
<li class=" tsd-kind-external-module">
<a href="resolve.html">resolve</a>
</li>
<li class=" tsd-kind-external-module">
<a href="state.html">state</a>
</li>
<li class=" tsd-kind-external-module">
<a href="transition.html">transition</a>
</li>
<li class=" tsd-kind-external-module">
<a href="url.html">url</a>
</li>
<li class=" tsd-kind-external-module">
<a href="view.html">view</a>
</li>
<li class="label tsd-is-external">
<span>Internal UI-<wbr><wbr>Router API</span>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_hof.html">common_<wbr>hof</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_predicates.html">common_<wbr>predicates</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="common_strings.html">common_<wbr>strings</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="hooks.html">hooks</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="path.html">path</a>
</li>
<li class=" tsd-kind-external-module tsd-is-external">
<a href="trace.html">trace</a>
</li>
<li class="current tsd-kind-external-module tsd-is-external">
<a href="vanilla.html">vanilla</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/vanilla.baselocationservices.html" class="tsd-kind-icon">Base<wbr>Location<wbr>Services</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/vanilla.browserlocationconfig.html" class="tsd-kind-icon">Browser<wbr>Location<wbr>Config</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/vanilla.hashlocationservice.html" class="tsd-kind-icon">Hash<wbr>Location<wbr>Service</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/vanilla.memorylocationconfig.html" class="tsd-kind-icon">Memory<wbr>Location<wbr>Config</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/vanilla.memorylocationservice.html" class="tsd-kind-icon">Memory<wbr>Location<wbr>Service</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/vanilla.pushstatelocationservice.html" class="tsd-kind-icon">Push<wbr>State<wbr>Location<wbr>Service</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/vanilla.historylike.html" class="tsd-kind-icon">History<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/vanilla.locationlike.html" class="tsd-kind-icon">Location<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/vanilla.locationplugin.html" class="tsd-kind-icon">Location<wbr>Plugin</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/vanilla.servicesplugin.html" class="tsd-kind-icon">Services<wbr>Plugin</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#_injector" class="tsd-kind-icon">$injector</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#_q" class="tsd-kind-icon">$q</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="vanilla.html#argument_names" class="tsd-kind-icon">ARGUMENT_<wbr>NAMES</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="vanilla.html#strip_comments" class="tsd-kind-icon">STRIP_<wbr>COMMENTS</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
<a href="vanilla.html#globals" class="tsd-kind-icon">globals</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#hashlocationplugin" class="tsd-kind-icon">hash<wbr>Location<wbr>Plugin</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#memorylocationplugin" class="tsd-kind-icon">memory<wbr>Location<wbr>Plugin</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#pushstatelocationplugin" class="tsd-kind-icon">push<wbr>State<wbr>Location<wbr>Plugin</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#buildurl" class="tsd-kind-icon">build<wbr>Url</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#getparams" class="tsd-kind-icon">get<wbr>Params</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#keyvalstoobjectr" class="tsd-kind-icon">key<wbr>Vals<wbr>ToObjectR</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#locationpluginfactory" class="tsd-kind-icon">location<wbr>Plugin<wbr>Factory</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#parseurl" class="tsd-kind-icon">parse<wbr>Url</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external">
<a href="vanilla.html#servicesplugin-1" class="tsd-kind-icon">services<wbr>Plugin</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"><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.io" 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>
You can’t perform that action at this time.