Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
962 lines (961 sloc) 54 KB
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>transition | @uirouter/angular</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/angular</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/angular</a>
</li>
<li>
<a href="transition.html">transition</a>
</li>
</ul>
<h1>Module transition</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 class="lead">
<h1 id="transition-subsystem">Transition subsystem</h1>
</div>
<p>This module contains APIs related to a Transition.</p>
<p>See:</p>
<ul>
<li><a href="../classes/transition.transitionservice.html">TransitionService</a></li>
<li><a href="../classes/transition.transition-1.html">Transition</a></li>
<li><a href="transition.html#hookfn">HookFn</a>, <a href="../interfaces/transition.transitionhookfn.html">TransitionHookFn</a>, <a href="../interfaces/transition.transitionstatehookfn.html">TransitionStateHookFn</a>, <a href="../interfaces/transition.hookmatchcriteria.html">HookMatchCriteria</a>, <a href="transition.html#hookresult">HookResult</a></li>
</ul>
</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 ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/transition.rejecttype.html" class="tsd-kind-icon">Reject<wbr>Type</a></li>
<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/transition.transitionhookphase.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Phase</a></li>
<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/transition.transitionhookscope.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Scope</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/transition.hookbuilder.html" class="tsd-kind-icon">Hook<wbr>Builder</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/transition.registeredhook.html" class="tsd-kind-icon">Registered<wbr>Hook</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/transition.rejection.html" class="tsd-kind-icon">Rejection</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/transition.transition-1.html" class="tsd-kind-icon">Transition</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-is-external"><a href="../classes/transition.transitioneventtype.html" class="tsd-kind-icon">Transition<wbr>Event<wbr>Type</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/transition.transitionservice.html" class="tsd-kind-icon">Transition<wbr>Service</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.hookmatchcriteria.html" class="tsd-kind-icon">Hook<wbr>Match<wbr>Criteria</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.hookregoptions.html" class="tsd-kind-icon">Hook<wbr>Reg<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported"><a href="../interfaces/transition.hooktuple.html" class="tsd-kind-icon">Hook<wbr>Tuple</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.ihookregistry.html" class="tsd-kind-icon">IHook<wbr>Registry</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.imatchingnodes.html" class="tsd-kind-icon">IMatching<wbr>Nodes</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.transitioncreatehookfn.html" class="tsd-kind-icon">Transition<wbr>Create<wbr>Hook<wbr>Fn</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.transitionhookfn.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Fn</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"><a href="../interfaces/transition.transitionhookoptions.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.transitionoptions.html" class="tsd-kind-icon">Transition<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-external"><a href="../interfaces/transition.transitionservicepluginapi.html" class="tsd-kind-icon">Transition<wbr>Service<wbr>PluginAPI</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.transitionstatehookfn.html" class="tsd-kind-icon">Transition<wbr>State<wbr>Hook<wbr>Fn</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/transition.treechanges.html" class="tsd-kind-icon">Tree<wbr>Changes</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#geterrorhandler" class="tsd-kind-icon">Get<wbr>Error<wbr>Handler</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#getresulthandler" class="tsd-kind-icon">Get<wbr>Result<wbr>Handler</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#hookfn" class="tsd-kind-icon">Hook<wbr>Fn</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#hookmatchcriterion" class="tsd-kind-icon">Hook<wbr>Match<wbr>Criterion</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#hookresult" class="tsd-kind-icon">Hook<wbr>Result</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#ihookregistration" class="tsd-kind-icon">IHook<wbr>Registration</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#istatematch" class="tsd-kind-icon">IState<wbr>Match</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="transition.html#resulthandler" class="tsd-kind-icon">Result<wbr>Handler</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="transition.html#tuplesort" class="tsd-kind-icon">tuple<wbr>Sort</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported"><a href="transition.html#defaultoptions" class="tsd-kind-icon">default<wbr>Options</a></li>
<li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="transition.html#defaulttransopts" class="tsd-kind-icon">default<wbr>Trans<wbr>Opts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="errorhandler" class="tsd-anchor"></a>
<!--
<h3>Error<wbr>Handler</h3>
-->
<div class="tsd-signature tsd-kind-icon">Error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<div class="tsd-declaration">
</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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>error <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionHook.ts#L31">core/src/transition/transitionHook.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="geterrorhandler" class="tsd-anchor"></a>
<!--
<h3>Get<wbr>Error<wbr>Handler</h3>
-->
<div class="tsd-signature tsd-kind-icon">Get<wbr>Error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<div class="tsd-declaration">
</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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hook<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TransitionHook</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transition.html#errorhandler" class="tsd-signature-type">ErrorHandler</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>hook <span class="tsd-signature-type">TransitionHook</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="transition.html#errorhandler" class="tsd-signature-type">ErrorHandler</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/0329205/src/transition/transitionHook.ts#L28">core/src/transition/transitionHook.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="getresulthandler" class="tsd-anchor"></a>
<!--
<h3>Get<wbr>Result<wbr>Handler</h3>
-->
<div class="tsd-signature tsd-kind-icon">Get<wbr>Result<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<div class="tsd-declaration">
</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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hook<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TransitionHook</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transition.html#resulthandler" class="tsd-signature-type">ResultHandler</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>hook <span class="tsd-signature-type">TransitionHook</span></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <a href="transition.html#resulthandler" class="tsd-signature-type">ResultHandler</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/0329205/src/transition/transitionHook.ts#L27">core/src/transition/transitionHook.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="hookfn" class="tsd-anchor"></a>
<!--
<h3>Hook<wbr>Fn</h3>
-->
<div class="tsd-signature tsd-kind-icon">Hook<wbr>Fn<span class="tsd-signature-symbol">:</span> <a href="../interfaces/transition.transitionhookfn.html" class="tsd-signature-type">TransitionHookFn</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/transition.transitionstatehookfn.html" class="tsd-signature-type">TransitionStateHookFn</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/transition.transitioncreatehookfn.html" class="tsd-signature-type">TransitionCreateHookFn</a></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/interface.ts#L240">core/src/transition/interface.ts:240</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="hookmatchcriterion" class="tsd-anchor"></a>
<!--
<h3>Hook<wbr>Match<wbr>Criterion</h3>
-->
<div class="tsd-signature tsd-kind-icon">Hook<wbr>Match<wbr>Criterion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span> <div class="tsd-header">
<p> Hook Criterion used to match a transition. </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hook Criterion used to match a transition.</p>
</div>
<p>A <a href="../classes/core.glob.html">Glob</a> string that matches the name of a state.</p>
<p>Or, a function with the signature <code>function(state) { return matches; }</code>
which should return a boolean to indicate if a state matches.</p>
<p>Or, <code>true</code> to always match</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/interface.ts#L833">core/src/transition/interface.ts:833</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="hookresult" class="tsd-anchor"></a>
<!--
<h3>Hook<wbr>Result</h3>
-->
<div class="tsd-signature tsd-kind-icon">Hook<wbr>Result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../classes/state.targetstate.html" class="tsd-signature-type">TargetState</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../classes/state.targetstate.html" class="tsd-signature-type">TargetState</a><span class="tsd-signature-symbol">&gt;</span> <div class="tsd-header">
<p> The return value of a <a href="../interfaces/transition.transitionhookfn.html">TransitionHookFn</a> or <a href="../interfaces/transition.transitionstatehookfn.html">TransitionStateHookFn</a> </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The return value of a <a href="../interfaces/transition.transitionhookfn.html">TransitionHookFn</a> or <a href="../interfaces/transition.transitionstatehookfn.html">TransitionStateHookFn</a></p>
</div>
<p>When returned from a <a href="../interfaces/transition.transitionhookfn.html">TransitionHookFn</a> or <a href="../interfaces/transition.transitionstatehookfn.html">TransitionStateHookFn</a>, these values alter the running <a href="../classes/transition.transition-1.html">Transition</a>:</p>
<ul>
<li><code>false</code>: the transition will be cancelled.</li>
<li><a href="../classes/state.targetstate.html">TargetState</a>: the transition will be redirected to the new target state (see: <a href="../classes/state.stateservice.html#target">StateService.target</a>)</li>
<li><code>Promise</code>: the transition will wait for the promise to resolve or reject<ul>
<li>If the promise is rejected (or resolves to <code>false</code>), the transition will be cancelled</li>
<li>If the promise resolves to a <a href="../classes/state.targetstate.html">TargetState</a>, the transition will be redirected</li>
<li>If the promise resolves to anything else, the transition will resume</li>
</ul>
</li>
<li>Anything else: the transition will resume</li>
</ul>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/interface.ts#L255">core/src/transition/interface.ts:255</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="ihookregistration" class="tsd-anchor"></a>
<!--
<h3>IHook<wbr>Registration</h3>
-->
<div class="tsd-signature tsd-kind-icon">IHook<wbr>Registration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<div class="tsd-declaration">
</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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>matchCriteria<span class="tsd-signature-symbol">: </span><a href="../interfaces/transition.hookmatchcriteria.html" class="tsd-signature-type">HookMatchCriteria</a>, callback<span class="tsd-signature-symbol">: </span><a href="transition.html#hookfn" class="tsd-signature-type">HookFn</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/transition.hookregoptions.html" class="tsd-signature-type">HookRegOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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>matchCriteria <a href="../interfaces/transition.hookmatchcriteria.html" class="tsd-signature-type">HookMatchCriteria</a></h5>
</li>
<li>
<h5>callback <a href="transition.html#hookfn" class="tsd-signature-type">HookFn</a></h5>
</li>
<li>
<h5>options: <span class="tsd-flag ts-flagOptional">Optional</span>&nbsp; <a href="../interfaces/transition.hookregoptions.html" class="tsd-signature-type">HookRegOptions</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/interface.ts#L173">core/src/transition/interface.ts:173</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="istatematch" class="tsd-anchor"></a>
<!--
<h3>IState<wbr>Match</h3>
-->
<div class="tsd-signature tsd-kind-icon">IState<wbr>Match<span class="tsd-signature-symbol">:</span> <a href="common.html#predicate" class="tsd-signature-type">Predicate</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/state.stateobject.html" class="tsd-signature-type">StateObject</a><span class="tsd-signature-symbol">&gt;</span> <div class="tsd-header">
<p> A predicate type which tests if a <a href="../classes/state.stateobject.html">StateObject</a> passes some test. Returns a boolean. </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A predicate type which tests if a <a href="../classes/state.stateobject.html">StateObject</a> passes some test. Returns a boolean.</p>
</div>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/interface.ts#L719">core/src/transition/interface.ts:719</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="resulthandler" class="tsd-anchor"></a>
<!--
<h3>Result<wbr>Handler</h3>
-->
<div class="tsd-signature tsd-kind-icon">Result<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<div class="tsd-declaration">
</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-type-alias tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><a href="transition.html#hookresult" class="tsd-signature-type">HookResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="transition.html#hookresult" class="tsd-signature-type">HookResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>result <a href="transition.html#hookresult" class="tsd-signature-type">HookResult</a></h5>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="transition.html#hookresult" class="tsd-signature-type">HookResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
</div>
</li>
</ul>
</li>
</ul>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionHook.ts#L30">core/src/transition/transitionHook.ts:30</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="tuplesort" class="tsd-anchor"></a>
<!--
<h3>tuple<wbr>Sort</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">tuple<wbr>Sort<span class="tsd-signature-symbol">(</span>reverseDepthSort<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><span class="tsd-signature-type">nodeDepthThenPriority</span></li>
<li class="tsd-header">
<p> A factory for a sort function for HookTuples. </p>
</li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A factory for a sort function for HookTuples.</p>
</div>
<p>The sort function first compares the PathNode depth (how deep in the state tree a node is), then compares
the EventHook priority.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>reverseDepthSort: <span class="tsd-flag ts-flagDefault value">Default value</span>&nbsp; <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5>
: <div class="tsd-comment tsd-typography">
<p>a boolean, when true, reverses the sort order for the node depth</p>
</div>
</li>
</ul>
<div class="tsd-returns">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">nodeDepthThenPriority</span></h4>
: <p>a tuple sort function</p>
</div>
<hr>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/hookBuilder.ts#L130">core/src/transition/hookBuilder.ts:130</a></li>
</ul>
</aside> </li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported">
<a name="defaultoptions" class="tsd-anchor"></a>
<!--
<h3>default<wbr>Options</h3>
-->
<div class="tsd-signature tsd-kind-icon">default<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionHook.ts#L20">core/src/transition/transitionHook.ts:20</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
<a name="defaultoptions.bind" class="tsd-anchor"></a>
<!--
<h3>bind</h3>
-->
<div class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionHook.ts#L24">core/src/transition/transitionHook.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
<a name="defaultoptions.current" class="tsd-anchor"></a>
<!--
<h3>current</h3>
-->
<div class="tsd-signature tsd-kind-icon">current<span class="tsd-signature-symbol">:</span> <a href="common.html#noop" class="tsd-signature-type">noop</a><span class="tsd-signature-symbol"> =&nbsp;noop</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionHook.ts#L21">core/src/transition/transitionHook.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
<a name="defaultoptions.tracedata" class="tsd-anchor"></a>
<!--
<h3>trace<wbr>Data</h3>
-->
<div class="tsd-signature tsd-kind-icon">trace<wbr>Data<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/0329205/src/transition/transitionHook.ts#L23">core/src/transition/transitionHook.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
<a name="defaultoptions.transition-2" class="tsd-anchor"></a>
<!--
<h3>transition</h3>
-->
<div class="tsd-signature tsd-kind-icon">transition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionHook.ts#L22">core/src/transition/transitionHook.ts:22</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module">
<a name="defaulttransopts" class="tsd-anchor"></a>
<!--
<h3>default<wbr>Trans<wbr>Opts</h3>
-->
<div class="tsd-signature tsd-kind-icon">default<wbr>Trans<wbr>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span> <div class="tsd-header">
<p> The default <a href="../classes/transition.transition-1.html">Transition</a> options. </p>
</div>
</div>
<div class="tsd-declaration">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The default <a href="../classes/transition.transition-1.html">Transition</a> options.</p>
</div>
<p>Include this object when applying custom defaults:
let reloadOpts = { reload: true, notify: true }
let options = defaults(theirOpts, customDefaults, defaultOptions);</p>
</div>
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L40">core/src/transition/transitionService.ts:40</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.custom" class="tsd-anchor"></a>
<!--
<h3>custom</h3>
-->
<div class="tsd-signature tsd-kind-icon">custom<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/0329205/src/transition/transitionService.ts#L46">core/src/transition/transitionService.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.inherit" class="tsd-anchor"></a>
<!--
<h3>inherit</h3>
-->
<div class="tsd-signature tsd-kind-icon">inherit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L43">core/src/transition/transitionService.ts:43</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.location" class="tsd-anchor"></a>
<!--
<h3>location</h3>
-->
<div class="tsd-signature tsd-kind-icon">location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L41">core/src/transition/transitionService.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.notify" class="tsd-anchor"></a>
<!--
<h3>notify</h3>
-->
<div class="tsd-signature tsd-kind-icon">notify<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;true</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L44">core/src/transition/transitionService.ts:44</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.relative" class="tsd-anchor"></a>
<!--
<h3>relative</h3>
-->
<div class="tsd-signature tsd-kind-icon">relative<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L42">core/src/transition/transitionService.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.reload" class="tsd-anchor"></a>
<!--
<h3>reload</h3>
-->
<div class="tsd-signature tsd-kind-icon">reload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L45">core/src/transition/transitionService.ts:45</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaulttransopts.source" class="tsd-anchor"></a>
<!--
<h3>source</h3>
-->
<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;unknown&quot;</span></div>
<div class="tsd-declaration">
</div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/0329205/src/transition/transitionService.ts#L48">core/src/transition/transitionService.ts:48</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
<a name="defaulttransopts.current-1" class="tsd-anchor"></a>
<!--
<h3>current</h3>
-->
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-object-literal">
<li class="tsd-signature tsd-kind-icon">current<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">
<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/0329205/src/transition/transitionService.ts#L47">core/src/transition/transitionService.ts:47</a></li>
</ul>
</aside> </li>
</ul>
</section>
</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/angular</em></a>
</li>
<li class="label tsd-is-external">
<span>Public API</span>
</li>
<li class=" tsd-kind-external-module">
<a href="core.html">core</a>
</li>
<li class=" tsd-kind-external-module">
<a href="directives.html">directives</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="current 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.html">common</a>
</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="ng2.html">ng2</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=" 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-enum tsd-parent-kind-external-module">
<a href="../enums/transition.rejecttype.html" class="tsd-kind-icon">Reject<wbr>Type</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/transition.transitionhookphase.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Phase</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/transition.transitionhookscope.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Scope</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/transition.hookbuilder.html" class="tsd-kind-icon">Hook<wbr>Builder</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/transition.registeredhook.html" class="tsd-kind-icon">Registered<wbr>Hook</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/transition.rejection.html" class="tsd-kind-icon">Rejection</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/transition.transition-1.html" class="tsd-kind-icon">Transition</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
<a href="../classes/transition.transitioneventtype.html" class="tsd-kind-icon">Transition<wbr>Event<wbr>Type</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="../classes/transition.transitionservice.html" class="tsd-kind-icon">Transition<wbr>Service</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.hookmatchcriteria.html" class="tsd-kind-icon">Hook<wbr>Match<wbr>Criteria</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.hookregoptions.html" class="tsd-kind-icon">Hook<wbr>Reg<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../interfaces/transition.hooktuple.html" class="tsd-kind-icon">Hook<wbr>Tuple</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.ihookregistry.html" class="tsd-kind-icon">IHook<wbr>Registry</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.imatchingnodes.html" class="tsd-kind-icon">IMatching<wbr>Nodes</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.transitioncreatehookfn.html" class="tsd-kind-icon">Transition<wbr>Create<wbr>Hook<wbr>Fn</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.transitionhookfn.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Fn</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/transition.transitionhookoptions.html" class="tsd-kind-icon">Transition<wbr>Hook<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.transitionoptions.html" class="tsd-kind-icon">Transition<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-external">
<a href="../interfaces/transition.transitionservicepluginapi.html" class="tsd-kind-icon">Transition<wbr>Service<wbr>PluginAPI</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.transitionstatehookfn.html" class="tsd-kind-icon">Transition<wbr>State<wbr>Hook<wbr>Fn</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/transition.treechanges.html" class="tsd-kind-icon">Tree<wbr>Changes</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#geterrorhandler" class="tsd-kind-icon">Get<wbr>Error<wbr>Handler</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#getresulthandler" class="tsd-kind-icon">Get<wbr>Result<wbr>Handler</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#hookfn" class="tsd-kind-icon">Hook<wbr>Fn</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#hookmatchcriterion" class="tsd-kind-icon">Hook<wbr>Match<wbr>Criterion</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#hookresult" class="tsd-kind-icon">Hook<wbr>Result</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#ihookregistration" class="tsd-kind-icon">IHook<wbr>Registration</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#istatematch" class="tsd-kind-icon">IState<wbr>Match</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="transition.html#resulthandler" class="tsd-kind-icon">Result<wbr>Handler</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="transition.html#tuplesort" class="tsd-kind-icon">tuple<wbr>Sort</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module tsd-is-not-exported">
<a href="transition.html#defaultoptions" class="tsd-kind-icon">default<wbr>Options</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module">
<a href="transition.html#defaulttransopts" class="tsd-kind-icon">default<wbr>Trans<wbr>Opts</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.