npm - @angular-wave/angular.ts - Versions diffs - 0.7.0-beta.0 → 0.7.1 - Mend

@angular-wave/angular.ts 0.7.0-beta.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1095) hide show

package/typedoc/interfaces/router_params_interface.ParamTypeDefinition.html ADDED Viewed

@@ -0,0 +1,1273 @@
+<!doctype html>
+<html class="default" lang="en" data-base="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="x-ua-compatible" content="IE=edge" />
+    <title>ParamTypeDefinition | AngularTS</title>
+    <meta name="description" content="Documentation for AngularTS" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="stylesheet" href="../assets/style.css" />
+    <link rel="stylesheet" href="../assets/highlight.css" />
+    <script defer src="../assets/main.js"></script>
+    <script async src="../assets/icons.js" id="tsd-icons-script"></script>
+    <script async src="../assets/search.js" id="tsd-search-script"></script>
+    <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
+    <script
+      async
+      src="../assets/hierarchy.js"
+      id="tsd-hierarchy-script"
+    ></script>
+  </head>
+  <body>
+    <script>
+      document.documentElement.dataset.theme =
+        localStorage.getItem("tsd-theme") || "os";
+      document.body.style.display = "none";
+      setTimeout(
+        () =>
+          window.app
+            ? app.showPage()
+            : document.body.style.removeProperty("display"),
+        500,
+      );
+    </script>
+    <header class="tsd-page-toolbar">
+      <div class="tsd-toolbar-contents container">
+        <a href="../index.html" class="title">AngularTS</a>
+        <div id="tsd-toolbar-links"></div>
+        <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
+          <svg
+            width="16"
+            height="16"
+            viewBox="0 0 16 16"
+            fill="none"
+            aria-hidden="true"
+          >
+            <use href="../assets/icons.svg#icon-search"></use>
+          </svg>
+        </button>
+        <dialog id="tsd-search" aria-label="Search">
+          <input
+            role="combobox"
+            id="tsd-search-input"
+            aria-controls="tsd-search-results"
+            aria-autocomplete="list"
+            aria-expanded="true"
+            autocapitalize="off"
+            autocomplete="off"
+            placeholder="Search the docs"
+            maxlength="100"
+          />
+          <ul role="listbox" id="tsd-search-results"></ul>
+          <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
+            <div>Preparing search index...</div>
+          </div>
+        </dialog>
+        <a
+          href="#"
+          class="tsd-widget menu"
+          id="tsd-toolbar-menu-trigger"
+          data-toggle="menu"
+          aria-label="Menu"
+          ><svg
+            width="16"
+            height="16"
+            viewBox="0 0 16 16"
+            fill="none"
+            aria-hidden="true"
+          >
+            <use href="../assets/icons.svg#icon-menu"></use></svg
+        ></a>
+      </div>
+    </header>
+    <div class="container container-main">
+      <div class="col-content">
+        <div class="tsd-page-title">
+          <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
+            <li>
+              <a href="../modules/router_params_interface.html"
+                >router/params/interface</a
+              >
+            </li>
+            <li><a href="" aria-current="page">ParamTypeDefinition</a></li>
+          </ul>
+          <h1>Interface ParamTypeDefinition</h1>
+        </div>
+        <section class="tsd-panel tsd-comment">
+          <div class="tsd-comment tsd-typography">
+            <p>Describes a custom [[ParamType]]</p>
+            <p>See: [[UrlMatcherFactory.type]]</p>
+            <p>
+              A developer can create a custom parameter type definition to
+              customize the encoding and decoding of parameter values. The
+              definition should implement all the methods of this interface.
+            </p>
+            <p>
+              Parameter values are parsed from the URL as strings. However, it
+              is often useful to parse the string into some other form, such as:
+            </p>
+            <ul>
+              <li>integer</li>
+              <li>date</li>
+              <li>array of &lt;integer/date/string&gt;</li>
+              <li>custom object</li>
+              <li>some internal string representation</li>
+            </ul>
+            <p>
+              Typed parameter definitions control how parameter values are
+              encoded (to the URL) and decoded (from the URL). UI-Router always
+              provides the decoded parameter values to the user (from methods
+              such as [[Transition.params]])).
+            </p>
+            <p>
+              For example, if a state has a url of
+              <code>/foo/{fooId:int}</code> (the <code>fooId</code> parameter is
+              of the <code>int</code> ParamType) and if the browser is at
+              <code>/foo/123</code>, then the 123 is parsed as an integer:
+            </p>
+            <pre><code class="js"><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">fooId</span><span class="hl-1"> = </span><span class="hl-10">transition</span><span class="hl-1">.</span><span class="hl-0">params</span><span class="hl-1">().</span><span class="hl-10">fooId</span><span class="hl-1">;</span><br/><span class="hl-10">fooId</span><span class="hl-1"> === </span><span class="hl-2">&quot;123&quot;</span><span class="hl-1"> </span><span class="hl-9">// false</span><br/><span class="hl-10">fooId</span><span class="hl-1"> === </span><span class="hl-16">123</span><span class="hl-1"> </span><span class="hl-9">// true</span>
+</code><button type="button">Copy</button></pre>
+            <h4 id="examples" class="tsd-anchor-link">
+              Examples<a
+                href="#examples"
+                aria-label="Permalink"
+                class="tsd-anchor-icon"
+                ><svg viewBox="0 0 24 24" aria-hidden="true">
+                  <use href="../assets/icons.svg#icon-anchor"></use></svg
+              ></a>
+            </h4>
+            <p>
+              This example encodes an array of integers as a dash-delimited
+              string to be used in the URL.
+            </p>
+            <p>
+              If we call
+              <code>$state.go('foo', { fooIds: [20, 30, 40] });</code>, the URL
+              changes to <code>/foo/20-30-40</code>. If we navigate to
+              <code>/foo/1-2-3</code>, the <code>foo</code> state's onEnter logs
+              <code>[1, 2, 3]</code>.
+            </p>
+          </div>
+          <div class="tsd-comment tsd-typography">
+            <div class="tsd-tag-example">
+              <h4 class="tsd-anchor-link" id="example">
+                Example<a
+                  href="#example"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h4>
+              <pre><code><br/><span class="hl-10">$urlMatcherFactoryProvider</span><span class="hl-1">.</span><span class="hl-0">type</span><span class="hl-1">(</span><span class="hl-2">&#39;intarray&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-9">// Take an array of ints [1,2,3] and return a string &quot;1-2-3&quot;</span><br/><span class="hl-1">  </span><span class="hl-0">encode</span><span class="hl-10">:</span><span class="hl-1"> (</span><span class="hl-10">array</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">array</span><span class="hl-1">.</span><span class="hl-0">join</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">),</span><br/><br/><span class="hl-1">  </span><span class="hl-9">// Take an string &quot;1-2-3&quot; and return an array of ints [1,2,3]</span><br/><span class="hl-1">  </span><span class="hl-0">decode</span><span class="hl-10">:</span><span class="hl-1"> (</span><span class="hl-10">str</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">str</span><span class="hl-1">.</span><span class="hl-0">split</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">).</span><span class="hl-0">map</span><span class="hl-1">(</span><span class="hl-10">x</span><span class="hl-1"> </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">x</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">)),</span><br/><br/><span class="hl-1">  </span><span class="hl-9">// Match the encoded string in the URL</span><br/><span class="hl-1">  </span><span class="hl-10">pattern:</span><span class="hl-1"> </span><span class="hl-11">new</span><span class="hl-1"> </span><span class="hl-0">RegExp</span><span class="hl-1">(</span><span class="hl-2">&quot;[0-9]+(?:-[0-9]+)*&quot;</span><span class="hl-1">)</span><br/><br/><span class="hl-1">  </span><span class="hl-9">// Ensure that the (decoded) object is an array, and that all its elements are numbers</span><br/><span class="hl-1">  </span><span class="hl-10">is</span><span class="hl-1">: (</span><span class="hl-10">obj</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">Array</span><span class="hl-1">.</span><span class="hl-0">isArray</span><span class="hl-1">(</span><span class="hl-10">obj</span><span class="hl-1">) &amp;&amp;</span><br/><span class="hl-1">      </span><span class="hl-10">obj</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">item</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-11">typeof</span><span class="hl-1"> </span><span class="hl-10">item</span><span class="hl-1"> === </span><span class="hl-2">&#39;number&#39;</span><span class="hl-1">, </span><span class="hl-11">true</span><span class="hl-1">),</span><br/><br/><span class="hl-1">  </span><span class="hl-9">// Compare two arrays of integers</span><br/><span class="hl-1">  </span><span class="hl-0">equals</span><span class="hl-10">:</span><span class="hl-1"> (</span><span class="hl-10">array1</span><span class="hl-1">, </span><span class="hl-10">array2</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">array1</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> === </span><span class="hl-10">array2</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> &amp;&amp;</span><br/><span class="hl-1">      </span><span class="hl-10">array1</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">item</span><span class="hl-1">, </span><span class="hl-10">idx</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-10">item</span><span class="hl-1"> === </span><span class="hl-10">array2</span><span class="hl-1">[</span><span class="hl-10">idx</span><span class="hl-1">], </span><span class="hl-11">true</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-10">$stateProvider</span><span class="hl-1">.</span><span class="hl-0">state</span><span class="hl-1">(</span><span class="hl-2">&#39;foo&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-10">url:</span><span class="hl-1"> </span><span class="hl-2">&quot;/foo/{fooIds:intarray}&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">onEnter</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">$transition$</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-10">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-10">$transition$</span><span class="hl-1">.</span><span class="hl-10">fooIds</span><span class="hl-1">); </span><span class="hl-9">// Logs &quot;[1, 2, 3]&quot;</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span>
+</code><button>Copy</button></pre>
+              <p>
+                This example decodes an integer from the URL. It uses the
+                integer as an index to look up an item from a static list. That
+                item from the list is the decoded parameter value.
+              </p>
+            </div>
+            <div class="tsd-tag-example">
+              <h4 class="tsd-anchor-link" id="example-1">
+                Example<a
+                  href="#example-1"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h4>
+              <pre><code><br/><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1"> = [</span><span class="hl-2">&#39;John&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;Paul&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;George&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;Ringo&#39;</span><span class="hl-1">];</span><br/><br/><span class="hl-10">$urlMatcherFactoryProvider</span><span class="hl-1">.</span><span class="hl-0">type</span><span class="hl-1">(</span><span class="hl-2">&#39;listItem&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-0">encode</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-9">// Represent the list item in the URL using its corresponding index</span><br/><span class="hl-1">    </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1">.</span><span class="hl-0">indexOf</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">);</span><br/><span class="hl-1">  },</span><br/><span class="hl-1">  </span><span class="hl-0">decode</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-9">// Look up the list item by index</span><br/><span class="hl-1">    </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1">[</span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">)];</span><br/><span class="hl-1">  },</span><br/><span class="hl-1">  </span><span class="hl-0">is</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-9">// Ensure the item is valid by checking to see that it appears</span><br/><span class="hl-1">    </span><span class="hl-9">// in the list</span><br/><span class="hl-1">    </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1">.</span><span class="hl-0">indexOf</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">) &gt; -</span><span class="hl-16">1</span><span class="hl-1">;</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-10">$stateProvider</span><span class="hl-1">.</span><span class="hl-0">state</span><span class="hl-1">(</span><span class="hl-2">&#39;list&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-10">url:</span><span class="hl-1"> </span><span class="hl-2">&quot;/list/{item:listItem}&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">controller</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">$scope</span><span class="hl-1">, </span><span class="hl-10">$stateParams</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-10">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-10">$stateParams</span><span class="hl-1">.</span><span class="hl-10">item</span><span class="hl-1">);</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">// ...</span><br/><br/><span class="hl-9">// Changes URL to &#39;/list/3&#39;, logs &quot;Ringo&quot; to the console</span><br/><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">go</span><span class="hl-1">(</span><span class="hl-2">&#39;list&#39;</span><span class="hl-1">, { </span><span class="hl-10">item:</span><span class="hl-1"> </span><span class="hl-2">&quot;Ringo&quot;</span><span class="hl-1"> });</span>
+</code><button>Copy</button></pre>
+              <p>See: [[UrlConfig.type]]</p>
+            </div>
+          </div>
+        </section>
+        <div class="tsd-signature">
+          <span class="tsd-signature-keyword">interface</span>
+          <span class="tsd-kind-interface">ParamTypeDefinition</span>
+          <span class="tsd-signature-symbol">{</span><br />    <a
+            class="tsd-kind-property"
+            href="#dynamic"
+            >dynamic</a
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">boolean</span
+          ><span class="tsd-signature-symbol">;</span><br />    <a
+            class="tsd-kind-property"
+            href="#inherit"
+            >inherit</a
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">boolean</span
+          ><span class="tsd-signature-symbol">;</span><br />    <a
+            class="tsd-kind-property"
+            href="#pattern"
+            >pattern</a
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">RegExp</span
+          ><span class="tsd-signature-symbol">;</span><br />    <a
+            class="tsd-kind-property"
+            href="#raw"
+            >raw</a
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">boolean</span
+          ><span class="tsd-signature-symbol">;</span><br />    <a
+            class="tsd-kind-call-signature"
+            href="#decode-1"
+            >decode</a
+          ><span class="tsd-signature-symbol">(</span
+          ><span class="tsd-kind-parameter">val</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">string</span
+          ><span class="tsd-signature-symbol">,</span>
+          <span class="tsd-kind-parameter">key</span
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">string</span
+          ><span class="tsd-signature-symbol">)</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">any</span
+          ><span class="tsd-signature-symbol">;</span><br />    <a
+            class="tsd-kind-call-signature"
+            href="#encode-1"
+            >encode</a
+          ><span class="tsd-signature-symbol">(</span
+          ><span class="tsd-kind-parameter">val</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">any</span
+          ><span class="tsd-signature-symbol">,</span>
+          <span class="tsd-kind-parameter">key</span
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">string</span
+          ><span class="tsd-signature-symbol">)</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">string</span>
+          <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><br />    <a
+            class="tsd-kind-call-signature"
+            href="#equals-1"
+            >equals</a
+          ><span class="tsd-signature-symbol">(</span
+          ><span class="tsd-kind-parameter">a</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">any</span
+          ><span class="tsd-signature-symbol">,</span>
+          <span class="tsd-kind-parameter">b</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-type">boolean</span
+          ><span class="tsd-signature-symbol">;</span><br />    <a
+            class="tsd-kind-call-signature"
+            href="#is-1"
+            >is</a
+          ><span class="tsd-signature-symbol">(</span
+          ><span class="tsd-kind-parameter">val</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">any</span
+          ><span class="tsd-signature-symbol">,</span>
+          <span class="tsd-kind-parameter">key</span
+          ><span class="tsd-signature-symbol">?:</span>
+          <span class="tsd-signature-type">string</span
+          ><span class="tsd-signature-symbol">)</span
+          ><span class="tsd-signature-symbol">:</span>
+          <span class="tsd-signature-type">boolean</span
+          ><span class="tsd-signature-symbol">;</span><br /><span
+            class="tsd-signature-symbol"
+            >}</span
+          >
+        </div>
+        <section class="tsd-panel-group tsd-index-group">
+          <section class="tsd-panel tsd-index-panel">
+            <details class="tsd-index-content tsd-accordion" open>
+              <summary class="tsd-accordion-summary tsd-index-summary">
+                <svg
+                  width="20"
+                  height="20"
+                  viewBox="0 0 24 24"
+                  fill="none"
+                  aria-hidden="true"
+                >
+                  <use href="../assets/icons.svg#icon-chevronDown"></use>
+                </svg>
+                <h5 class="tsd-index-heading uppercase">Index</h5>
+              </summary>
+              <div class="tsd-accordion-details">
+                <section class="tsd-index-section">
+                  <h3 class="tsd-index-heading">Properties</h3>
+                  <div class="tsd-index-list">
+                    <a href="#dynamic" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Property"
+                      >
+                        <use href="../assets/icons.svg#icon-1024"></use></svg
+                      ><span>dynamic?</span></a
+                    >
+                    <a href="#inherit" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Property"
+                      >
+                        <use href="../assets/icons.svg#icon-1024"></use></svg
+                      ><span>inherit?</span></a
+                    >
+                    <a href="#pattern" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Property"
+                      >
+                        <use href="../assets/icons.svg#icon-1024"></use></svg
+                      ><span>pattern?</span></a
+                    >
+                    <a href="#raw" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Property"
+                      >
+                        <use href="../assets/icons.svg#icon-1024"></use></svg
+                      ><span>raw?</span></a
+                    >
+                  </div>
+                </section>
+                <section class="tsd-index-section">
+                  <h3 class="tsd-index-heading">Methods</h3>
+                  <div class="tsd-index-list">
+                    <a href="#decode" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Method"
+                      >
+                        <use href="../assets/icons.svg#icon-2048"></use></svg
+                      ><span>decode</span></a
+                    >
+                    <a href="#encode" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Method"
+                      >
+                        <use href="../assets/icons.svg#icon-2048"></use></svg
+                      ><span>encode</span></a
+                    >
+                    <a href="#equals" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Method"
+                      >
+                        <use href="../assets/icons.svg#icon-2048"></use></svg
+                      ><span>equals</span></a
+                    >
+                    <a href="#is" class="tsd-index-link"
+                      ><svg
+                        class="tsd-kind-icon"
+                        viewBox="0 0 24 24"
+                        aria-label="Method"
+                      >
+                        <use href="../assets/icons.svg#icon-2048"></use></svg
+                      ><span>is</span></a
+                    >
+                  </div>
+                </section>
+              </div>
+            </details>
+          </section>
+        </section>
+        <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
+          <summary class="tsd-accordion-summary" data-key="section-Properties">
+            <svg
+              width="20"
+              height="20"
+              viewBox="0 0 24 24"
+              fill="none"
+              aria-hidden="true"
+            >
+              <use href="../assets/icons.svg#icon-chevronDown"></use>
+            </svg>
+            <h2>Properties</h2>
+          </summary>
+          <section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="dynamic">
+                <code class="tsd-tag">Optional</code><span>dynamic</span
+                ><a
+                  href="#dynamic"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <div class="tsd-signature">
+                <span class="tsd-kind-property">dynamic</span
+                ><span class="tsd-signature-symbol">?:</span>
+                <span class="tsd-signature-type">boolean</span>
+              </div>
+              <div class="tsd-comment tsd-typography">
+                <p>Dynamic flag</p>
+                <p>
+                  When <code>dynamic</code> is <code>true</code>, changes to the
+                  parameter value will not cause the state to be entered/exited.
+                </p>
+                <p>
+                  Normally, if a parameter value changes, the state which
+                  declared that the parameter will be reloaded (entered/exited).
+                  When a parameter is <code>dynamic</code>, a transition still
+                  occurs, but it does not cause the state to exit/enter.
+                </p>
+                <p>Default: <code>false</code></p>
+              </div>
+              <div class="tsd-comment tsd-typography"></div>
+            </section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="inherit">
+                <code class="tsd-tag">Optional</code><span>inherit</span
+                ><a
+                  href="#inherit"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <div class="tsd-signature">
+                <span class="tsd-kind-property">inherit</span
+                ><span class="tsd-signature-symbol">?:</span>
+                <span class="tsd-signature-type">boolean</span>
+              </div>
+              <div class="tsd-comment tsd-typography">
+                <p>
+                  Enables/disables inheriting of parameter values (of this type)
+                </p>
+                <p>
+                  When a transition is run with [[TransitionOptions.inherit]]
+                  set to <code>true</code>, the current param values are
+                  inherited in the new transition. However, parameters whose
+                  type has <code>inherit: false</code> set will
+                  <em>not be inherited</em>.
+                </p>
+                <p>
+                  The internal parameter type of <code>hash</code> has
+                  <code>inherit: false</code>. This is used to disable
+                  inheriting of the hash value (<code>#</code>) on subsequent
+                  transitions.
+                </p>
+                <h4 id="example-2" class="tsd-anchor-link">
+                  Example:<a
+                    href="#example-2"
+                    aria-label="Permalink"
+                    class="tsd-anchor-icon"
+                    ><svg viewBox="0 0 24 24" aria-hidden="true">
+                      <use href="../assets/icons.svg#icon-anchor"></use></svg
+                  ></a>
+                </h4>
+                <pre><code class="js"><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">go</span><span class="hl-1">(</span><span class="hl-2">&#39;home&#39;</span><span class="hl-1">, { </span><span class="hl-2">&#39;#&#39;</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-2">&#39;inboxAnchor&#39;</span><span class="hl-1"> });</span><br/><span class="hl-1">...</span><br/><span class="hl-9">// &quot;#&quot; is not inherited.</span><br/><span class="hl-9">// The value of the &quot;#&quot; parameter will be `null`</span><br/><span class="hl-9">// The url&#39;s hash will be cleared.</span><br/><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">go</span><span class="hl-1">(</span><span class="hl-2">&#39;home.nest&#39;</span><span class="hl-1">);</span>
+</code><button type="button">Copy</button></pre>
+                <hr />
+                <p>
+                  See also [[TransitionOptions.inherit]] and
+                  [[ParamDeclaration.inherit]]
+                </p>
+              </div>
+              <div class="tsd-comment tsd-typography"></div>
+            </section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="pattern">
+                <code class="tsd-tag">Optional</code><span>pattern</span
+                ><a
+                  href="#pattern"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <div class="tsd-signature">
+                <span class="tsd-kind-property">pattern</span
+                ><span class="tsd-signature-symbol">?:</span>
+                <span class="tsd-signature-type">RegExp</span>
+              </div>
+              <div class="tsd-comment tsd-typography">
+                <p>
+                  A regular expression that matches the encoded parameter type
+                </p>
+                <p>
+                  This regular expression is used to match an encoded parameter
+                  value <strong>in the URL</strong>.
+                </p>
+                <p>
+                  For example, if your type encodes as a dash-separated numbers,
+                  match that here:
+                  <code>new RegExp(&quot;[0-9]+(?:-[0-9]+)*&quot;)</code>.
+                </p>
+                <p>There are some limitations to these regexps:</p>
+                <ul>
+                  <li>
+                    No capturing groups are allowed (use non-capturing groups:
+                    <code>(?: )</code>)
+                  </li>
+                  <li>No pattern modifiers like case insensitive</li>
+                  <li>
+                    No start-of-string or end-of-string: <code>/^foo$/</code>
+                  </li>
+                </ul>
+              </div>
+              <div class="tsd-comment tsd-typography"></div>
+            </section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="raw">
+                <code class="tsd-tag">Optional</code><span>raw</span
+                ><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <div class="tsd-signature">
+                <span class="tsd-kind-property">raw</span
+                ><span class="tsd-signature-symbol">?:</span>
+                <span class="tsd-signature-type">boolean</span>
+              </div>
+              <div class="tsd-comment tsd-typography">
+                <p>Disables url-encoding of parameter values</p>
+                <p>
+                  If a parameter type is declared <code>raw</code>, it will not
+                  be url-encoded. Custom encoding can still be applied in the
+                  [[encode]] function.
+                </p>
+                <h3 id="decoding-warning" class="tsd-anchor-link">
+                  Decoding warning<a
+                    href="#decoding-warning"
+                    aria-label="Permalink"
+                    class="tsd-anchor-icon"
+                    ><svg viewBox="0 0 24 24" aria-hidden="true">
+                      <use href="../assets/icons.svg#icon-anchor"></use></svg
+                  ></a>
+                </h3>
+                <p>
+                  The decoding behavior of raw parameters is not defined. See:
+                  [[ParamDeclaration.raw]] for details
+                </p>
+              </div>
+              <div class="tsd-comment tsd-typography"></div>
+            </section>
+          </section>
+        </details>
+        <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
+          <summary class="tsd-accordion-summary" data-key="section-Methods">
+            <svg
+              width="20"
+              height="20"
+              viewBox="0 0 24 24"
+              fill="none"
+              aria-hidden="true"
+            >
+              <use href="../assets/icons.svg#icon-chevronDown"></use>
+            </svg>
+            <h2>Methods</h2>
+          </summary>
+          <section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="decode">
+                <span>decode</span
+                ><a
+                  href="#decode"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <ul class="tsd-signatures">
+                <li class="">
+                  <div class="tsd-signature tsd-anchor-link" id="decode-1">
+                    <span class="tsd-kind-call-signature">decode</span
+                    ><span class="tsd-signature-symbol">(</span
+                    ><span class="tsd-kind-parameter">val</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">string</span
+                    ><span class="tsd-signature-symbol">,</span>
+                    <span class="tsd-kind-parameter">key</span
+                    ><span class="tsd-signature-symbol">?:</span>
+                    <span class="tsd-signature-type">string</span
+                    ><span class="tsd-signature-symbol">)</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">any</span
+                    ><a
+                      href="#decode-1"
+                      aria-label="Permalink"
+                      class="tsd-anchor-icon"
+                      ><svg viewBox="0 0 24 24" aria-hidden="true">
+                        <use href="../assets/icons.svg#icon-anchor"></use></svg
+                    ></a>
+                  </div>
+                  <div class="tsd-description">
+                    <div class="tsd-comment tsd-typography">
+                      <p>
+                        Decodes a parameter value string (from URL string or
+                        transition param) to a custom/native value.
+                      </p>
+                      <p>
+                        For example, if your type decodes to an array of ints,
+                        then decode the string as an array of ints here:
+                      </p>
+                      <pre><code class="js"><span class="hl-15">decode</span><span class="hl-1">: (</span><span class="hl-10">str</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">str</span><span class="hl-1">.</span><span class="hl-0">split</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">).</span><span class="hl-0">map</span><span class="hl-1">(</span><span class="hl-10">str</span><span class="hl-1"> </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">str</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">))</span>
+</code><button type="button">Copy</button></pre>
+                      <p>
+                        Note: in general, [[encode]] and [[decode]] should be
+                        symmetrical. That is,
+                        <code>encode(decode(str)) === str</code>
+                      </p>
+                    </div>
+                    <div class="tsd-parameters">
+                      <h4 class="tsd-parameters-title">Parameters</h4>
+                      <ul class="tsd-parameter-list">
+                        <li>
+                          <span
+                            ><span class="tsd-kind-parameter">val</span>:
+                            <span class="tsd-signature-type">string</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>The URL parameter value to decode.</p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                        <li>
+                          <span
+                            ><code class="tsd-tag">Optional</code
+                            ><span class="tsd-kind-parameter">key</span>:
+                            <span class="tsd-signature-type">string</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>
+                              The name of the parameter in which
+                              <code>val</code> is stored. Can be used for
+                              meta-programming of
+                              <code>ParamType</code> objects.
+                            </p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                      </ul>
+                    </div>
+                    <h4 class="tsd-returns-title">
+                      Returns <span class="tsd-signature-type">any</span>
+                    </h4>
+                    <p>a custom representation of the URL parameter value.</p>
+                    <div class="tsd-comment tsd-typography"></div>
+                  </div>
+                </li>
+              </ul>
+            </section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="encode">
+                <span>encode</span
+                ><a
+                  href="#encode"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <ul class="tsd-signatures">
+                <li class="">
+                  <div class="tsd-signature tsd-anchor-link" id="encode-1">
+                    <span class="tsd-kind-call-signature">encode</span
+                    ><span class="tsd-signature-symbol">(</span
+                    ><span class="tsd-kind-parameter">val</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">any</span
+                    ><span class="tsd-signature-symbol">,</span>
+                    <span class="tsd-kind-parameter">key</span
+                    ><span class="tsd-signature-symbol">?:</span>
+                    <span class="tsd-signature-type">string</span
+                    ><span class="tsd-signature-symbol">)</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">string</span>
+                    <span class="tsd-signature-symbol">|</span>
+                    <span class="tsd-signature-type">string</span
+                    ><span class="tsd-signature-symbol">[]</span
+                    ><a
+                      href="#encode-1"
+                      aria-label="Permalink"
+                      class="tsd-anchor-icon"
+                      ><svg viewBox="0 0 24 24" aria-hidden="true">
+                        <use href="../assets/icons.svg#icon-anchor"></use></svg
+                    ></a>
+                  </div>
+                  <div class="tsd-description">
+                    <div class="tsd-comment tsd-typography">
+                      <p>
+                        Encodes a custom/native type value to a string that can
+                        be embedded in a URL.
+                      </p>
+                      <p>
+                        Note that the return value does <em>not</em> need to be
+                        URL-safe (i.e. passed through
+                        <code>encodeURIComponent()</code>). It only needs to be
+                        a representation of <code>val</code> that has been
+                        encoded as a string.
+                      </p>
+                      <p>
+                        For example, if your custom type decodes to an array of
+                        ints, then encode the array of ints to a string here:
+                      </p>
+                      <pre><code class="js"><span class="hl-15">encode</span><span class="hl-1">: (</span><span class="hl-10">intarray</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">intarray</span><span class="hl-1">.</span><span class="hl-0">join</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">)</span>
+</code><button type="button">Copy</button></pre>
+                      <p>
+                        Note: in general, [[encode]] and [[decode]] should be
+                        symmetrical. That is,
+                        <code>encode(decode(str)) === str</code>
+                      </p>
+                    </div>
+                    <div class="tsd-parameters">
+                      <h4 class="tsd-parameters-title">Parameters</h4>
+                      <ul class="tsd-parameter-list">
+                        <li>
+                          <span
+                            ><span class="tsd-kind-parameter">val</span>:
+                            <span class="tsd-signature-type">any</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>The value to encode.</p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                        <li>
+                          <span
+                            ><code class="tsd-tag">Optional</code
+                            ><span class="tsd-kind-parameter">key</span>:
+                            <span class="tsd-signature-type">string</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>
+                              The name of the parameter in which
+                              <code>val</code> is stored. Can be used for
+                              meta-programming of
+                              <code>ParamType</code> objects.
+                            </p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                      </ul>
+                    </div>
+                    <h4 class="tsd-returns-title">
+                      Returns <span class="tsd-signature-type">string</span>
+                      <span class="tsd-signature-symbol">|</span>
+                      <span class="tsd-signature-type">string</span
+                      ><span class="tsd-signature-symbol">[]</span>
+                    </h4>
+                    <p>
+                      a string representation of <code>val</code> that can be
+                      encoded in a URL.
+                    </p>
+                    <div class="tsd-comment tsd-typography"></div>
+                  </div>
+                </li>
+              </ul>
+            </section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="equals">
+                <span>equals</span
+                ><a
+                  href="#equals"
+                  aria-label="Permalink"
+                  class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <ul class="tsd-signatures">
+                <li class="">
+                  <div class="tsd-signature tsd-anchor-link" id="equals-1">
+                    <span class="tsd-kind-call-signature">equals</span
+                    ><span class="tsd-signature-symbol">(</span
+                    ><span class="tsd-kind-parameter">a</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">any</span
+                    ><span class="tsd-signature-symbol">,</span>
+                    <span class="tsd-kind-parameter">b</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-type">boolean</span
+                    ><a
+                      href="#equals-1"
+                      aria-label="Permalink"
+                      class="tsd-anchor-icon"
+                      ><svg viewBox="0 0 24 24" aria-hidden="true">
+                        <use href="../assets/icons.svg#icon-anchor"></use></svg
+                    ></a>
+                  </div>
+                  <div class="tsd-description">
+                    <div class="tsd-comment tsd-typography">
+                      <p>
+                        Determines whether two decoded values are equivalent.
+                      </p>
+                      <p>
+                        For example, if your type decodes to an array of ints,
+                        then check if the arrays are equal:
+                      </p>
+                      <pre><code class="js"><span class="hl-15">equals</span><span class="hl-1">: (</span><span class="hl-10">a</span><span class="hl-1">, </span><span class="hl-10">b</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">a</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> === </span><span class="hl-10">b</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> &amp;&amp; </span><span class="hl-10">a</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">x</span><span class="hl-1">, </span><span class="hl-10">idx</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-10">x</span><span class="hl-1"> === </span><span class="hl-10">b</span><span class="hl-1">[</span><span class="hl-10">idx</span><span class="hl-1">], </span><span class="hl-11">true</span><span class="hl-1">)</span>
+</code><button type="button">Copy</button></pre>
+                    </div>
+                    <div class="tsd-parameters">
+                      <h4 class="tsd-parameters-title">Parameters</h4>
+                      <ul class="tsd-parameter-list">
+                        <li>
+                          <span
+                            ><span class="tsd-kind-parameter">a</span>:
+                            <span class="tsd-signature-type">any</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>A value to compare against.</p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                        <li>
+                          <span
+                            ><span class="tsd-kind-parameter">b</span>:
+                            <span class="tsd-signature-type">any</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>A value to compare against.</p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                      </ul>
+                    </div>
+                    <h4 class="tsd-returns-title">
+                      Returns <span class="tsd-signature-type">boolean</span>
+                    </h4>
+                    <p>
+                      <code>true</code> if the values are equivalent/equal,
+                      otherwise <code>false</code>.
+                    </p>
+                    <div class="tsd-comment tsd-typography"></div>
+                  </div>
+                </li>
+              </ul>
+            </section>
+            <section class="tsd-panel tsd-member">
+              <h3 class="tsd-anchor-link" id="is">
+                <span>is</span
+                ><a href="#is" aria-label="Permalink" class="tsd-anchor-icon"
+                  ><svg viewBox="0 0 24 24" aria-hidden="true">
+                    <use href="../assets/icons.svg#icon-anchor"></use></svg
+                ></a>
+              </h3>
+              <ul class="tsd-signatures">
+                <li class="">
+                  <div class="tsd-signature tsd-anchor-link" id="is-1">
+                    <span class="tsd-kind-call-signature">is</span
+                    ><span class="tsd-signature-symbol">(</span
+                    ><span class="tsd-kind-parameter">val</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">any</span
+                    ><span class="tsd-signature-symbol">,</span>
+                    <span class="tsd-kind-parameter">key</span
+                    ><span class="tsd-signature-symbol">?:</span>
+                    <span class="tsd-signature-type">string</span
+                    ><span class="tsd-signature-symbol">)</span
+                    ><span class="tsd-signature-symbol">:</span>
+                    <span class="tsd-signature-type">boolean</span
+                    ><a
+                      href="#is-1"
+                      aria-label="Permalink"
+                      class="tsd-anchor-icon"
+                      ><svg viewBox="0 0 24 24" aria-hidden="true">
+                        <use href="../assets/icons.svg#icon-anchor"></use></svg
+                    ></a>
+                  </div>
+                  <div class="tsd-description">
+                    <div class="tsd-comment tsd-typography">
+                      <p>
+                        Tests if some object type is compatible with this
+                        parameter type
+                      </p>
+                      <p>
+                        Detects whether some value is of this particular type.
+                        Accepts a decoded value and determines whether it
+                        matches this <code>ParamType</code> object.
+                      </p>
+                      <p>
+                        If your custom type encodes the parameter to a specific
+                        type, check for that type here. For example, if your
+                        custom type decodes the URL parameter value as an array
+                        of ints, return true if the input is an array of ints:
+                      </p>
+                      <pre><code><span class="hl-15">is</span><span class="hl-1">: (</span><span class="hl-10">val</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">Array</span><span class="hl-1">.</span><span class="hl-0">isArray</span><span class="hl-1">(</span><span class="hl-10">val</span><span class="hl-1">) &amp;&amp; </span><span class="hl-10">array</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">x</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">val</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">) === </span><span class="hl-10">val</span><span class="hl-1">, </span><span class="hl-11">true</span><span class="hl-1">)</span>
+</code><button>Copy</button></pre>
+                      <p>
+                        If your type decodes the URL parameter value to a custom
+                        string, check that the string matches the pattern (don't
+                        use an arrow fn if you need <code>this</code>):
+                        <code
+                          >function (val) { return !!this.pattern.exec(val)
+                          }</code
+                        >
+                      </p>
+                      <p>
+                        Note: This method is
+                        <em>not used to check if the URL matches</em>. It's used
+                        to check if a
+                        <em>decoded value <em>is</em> this type</em>. Use
+                        [[pattern]] to check the encoded value in the URL.
+                      </p>
+                    </div>
+                    <div class="tsd-parameters">
+                      <h4 class="tsd-parameters-title">Parameters</h4>
+                      <ul class="tsd-parameter-list">
+                        <li>
+                          <span
+                            ><span class="tsd-kind-parameter">val</span>:
+                            <span class="tsd-signature-type">any</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>The value to check.</p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                        <li>
+                          <span
+                            ><code class="tsd-tag">Optional</code
+                            ><span class="tsd-kind-parameter">key</span>:
+                            <span class="tsd-signature-type">string</span></span
+                          >
+                          <div class="tsd-comment tsd-typography">
+                            <p>
+                              If the type check is happening in the context of a
+                              specific [[UrlMatcher]] object, this is the name
+                              of the parameter in which <code>val</code> is
+                              stored. Can be used for meta-programming of
+                              <code>ParamType</code> objects.
+                            </p>
+                          </div>
+                          <div class="tsd-comment tsd-typography"></div>
+                        </li>
+                      </ul>
+                    </div>
+                    <h4 class="tsd-returns-title">
+                      Returns <span class="tsd-signature-type">boolean</span>
+                    </h4>
+                    <p>
+                      <code>true</code> if the value matches the type, otherwise
+                      <code>false</code>.
+                    </p>
+                    <div class="tsd-comment tsd-typography"></div>
+                  </div>
+                </li>
+              </ul>
+            </section>
+          </section>
+        </details>
+      </div>
+      <div class="col-sidebar">
+        <div class="page-menu">
+          <div class="tsd-navigation settings">
+            <details class="tsd-accordion">
+              <summary class="tsd-accordion-summary">
+                <svg
+                  width="20"
+                  height="20"
+                  viewBox="0 0 24 24"
+                  fill="none"
+                  aria-hidden="true"
+                >
+                  <use href="../assets/icons.svg#icon-chevronDown"></use>
+                </svg>
+                <h3>Settings</h3>
+              </summary>
+              <div class="tsd-accordion-details">
+                <div class="tsd-filter-visibility">
+                  <span class="settings-label">Member Visibility</span>
+                  <ul id="tsd-filter-options">
+                    <li class="tsd-filter-item">
+                      <label class="tsd-filter-input"
+                        ><input
+                          type="checkbox"
+                          id="tsd-filter-protected"
+                          name="protected"
+                        /><svg
+                          width="32"
+                          height="32"
+                          viewBox="0 0 32 32"
+                          aria-hidden="true"
+                        >
+                          <rect
+                            class="tsd-checkbox-background"
+                            width="30"
+                            height="30"
+                            x="1"
+                            y="1"
+                            rx="6"
+                            fill="none"
+                          ></rect>
+                          <path
+                            class="tsd-checkbox-checkmark"
+                            d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
+                            stroke="none"
+                            stroke-width="3.5"
+                            stroke-linejoin="round"
+                            fill="none"
+                          ></path></svg
+                        ><span>Protected</span></label
+                      >
+                    </li>
+                    <li class="tsd-filter-item">
+                      <label class="tsd-filter-input"
+                        ><input
+                          type="checkbox"
+                          id="tsd-filter-inherited"
+                          name="inherited"
+                          checked
+                        /><svg
+                          width="32"
+                          height="32"
+                          viewBox="0 0 32 32"
+                          aria-hidden="true"
+                        >
+                          <rect
+                            class="tsd-checkbox-background"
+                            width="30"
+                            height="30"
+                            x="1"
+                            y="1"
+                            rx="6"
+                            fill="none"
+                          ></rect>
+                          <path
+                            class="tsd-checkbox-checkmark"
+                            d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
+                            stroke="none"
+                            stroke-width="3.5"
+                            stroke-linejoin="round"
+                            fill="none"
+                          ></path></svg
+                        ><span>Inherited</span></label
+                      >
+                    </li>
+                    <li class="tsd-filter-item">
+                      <label class="tsd-filter-input"
+                        ><input
+                          type="checkbox"
+                          id="tsd-filter-external"
+                          name="external"
+                        /><svg
+                          width="32"
+                          height="32"
+                          viewBox="0 0 32 32"
+                          aria-hidden="true"
+                        >
+                          <rect
+                            class="tsd-checkbox-background"
+                            width="30"
+                            height="30"
+                            x="1"
+                            y="1"
+                            rx="6"
+                            fill="none"
+                          ></rect>
+                          <path
+                            class="tsd-checkbox-checkmark"
+                            d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
+                            stroke="none"
+                            stroke-width="3.5"
+                            stroke-linejoin="round"
+                            fill="none"
+                          ></path></svg
+                        ><span>External</span></label
+                      >
+                    </li>
+                  </ul>
+                </div>
+                <div class="tsd-theme-toggle">
+                  <label class="settings-label" for="tsd-theme">Theme</label
+                  ><select id="tsd-theme">
+                    <option value="os">OS</option>
+                    <option value="light">Light</option>
+                    <option value="dark">Dark</option>
+                  </select>
+                </div>
+              </div>
+            </details>
+          </div>
+          <details open class="tsd-accordion tsd-page-navigation">
+            <summary class="tsd-accordion-summary">
+              <svg
+                width="20"
+                height="20"
+                viewBox="0 0 24 24"
+                fill="none"
+                aria-hidden="true"
+              >
+                <use href="../assets/icons.svg#icon-chevronDown"></use>
+              </svg>
+              <h3>On This Page</h3>
+            </summary>
+            <div class="tsd-accordion-details">
+              <a href="#examples"><span>Examples</span></a>
+              <details open class="tsd-accordion tsd-page-navigation-section">
+                <summary
+                  class="tsd-accordion-summary"
+                  data-key="section-Properties"
+                >
+                  <svg
+                    width="20"
+                    height="20"
+                    viewBox="0 0 24 24"
+                    fill="none"
+                    aria-hidden="true"
+                  >
+                    <use href="../assets/icons.svg#icon-chevronDown"></use></svg
+                  >Properties
+                </summary>
+                <div>
+                  <a href="#dynamic"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Property"
+                    >
+                      <use href="../assets/icons.svg#icon-1024"></use></svg
+                    ><span>dynamic</span></a
+                  ><a href="#inherit"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Property"
+                    >
+                      <use href="../assets/icons.svg#icon-1024"></use></svg
+                    ><span>inherit</span></a
+                  >
+                  <ul>
+                    <li>
+                      <ul>
+                        <li>
+                          <ul>
+                            <li>
+                              <ul>
+                                <li>
+                                  <a href="#example-2"><span>Example:</span></a>
+                                </li>
+                              </ul>
+                            </li>
+                          </ul>
+                        </li>
+                      </ul>
+                    </li>
+                  </ul>
+                  <a href="#pattern"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Property"
+                    >
+                      <use href="../assets/icons.svg#icon-1024"></use></svg
+                    ><span>pattern</span></a
+                  ><a href="#raw"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Property"
+                    >
+                      <use href="../assets/icons.svg#icon-1024"></use></svg
+                    ><span>raw</span></a
+                  >
+                  <ul>
+                    <li>
+                      <a href="#decoding-warning"
+                        ><span>Decoding warning</span></a
+                      >
+                    </li>
+                  </ul>
+                </div>
+              </details>
+              <details open class="tsd-accordion tsd-page-navigation-section">
+                <summary
+                  class="tsd-accordion-summary"
+                  data-key="section-Methods"
+                >
+                  <svg
+                    width="20"
+                    height="20"
+                    viewBox="0 0 24 24"
+                    fill="none"
+                    aria-hidden="true"
+                  >
+                    <use href="../assets/icons.svg#icon-chevronDown"></use></svg
+                  >Methods
+                </summary>
+                <div>
+                  <a href="#decode"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Method"
+                    >
+                      <use href="../assets/icons.svg#icon-2048"></use></svg
+                    ><span>decode</span></a
+                  ><a href="#encode"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Method"
+                    >
+                      <use href="../assets/icons.svg#icon-2048"></use></svg
+                    ><span>encode</span></a
+                  ><a href="#equals"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Method"
+                    >
+                      <use href="../assets/icons.svg#icon-2048"></use></svg
+                    ><span>equals</span></a
+                  ><a href="#is"
+                    ><svg
+                      class="tsd-kind-icon"
+                      viewBox="0 0 24 24"
+                      aria-label="Method"
+                    >
+                      <use href="../assets/icons.svg#icon-2048"></use></svg
+                    ><span>is</span></a
+                  >
+                </div>
+              </details>
+            </div>
+          </details>
+        </div>
+        <div class="site-menu">
+          <nav class="tsd-navigation">
+            <a href="../modules.html">AngularTS</a>
+            <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
+              <li>Loading...</li>
+            </ul>
+          </nav>
+        </div>
+      </div>
+    </div>
+    <footer>
+      <p class="tsd-generator">
+        Generated using
+        <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
+      </p>
+    </footer>
+    <div class="overlay"></div>
+  </body>
+</html>