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/classes/router_common_glob.Glob.html CHANGED Viewed

@@ -3,11 +3,8 @@
   <head>
     <meta charset="utf-8" />
     <meta http-equiv="x-ua-compatible" content="IE=edge" />
-    <title>Glob | @angular-wave/angular.ts</title>
-    <meta
-      name="description"
-      content="Documentation for @angular-wave/angular.ts"
-    />
+    <title>Glob | 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" />
@@ -36,7 +33,7 @@
     </script>
     <header class="tsd-page-toolbar">
       <div class="tsd-toolbar-contents container">
-        <a href="../index.html" class="title">@angular-wave/angular.ts</a>
+        <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
@@ -96,17 +93,184 @@
           </ul>
           <h1>Class Glob</h1>
         </div>
-        <aside class="tsd-sources">
-          <ul>
-            <li>
-              Defined in
-              <a
-                href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L50"
-                >router/common/glob.js:50</a
-              >
-            </li>
-          </ul>
-        </aside>
+        <section class="tsd-panel tsd-comment">
+          <div class="tsd-comment tsd-typography">
+            <p>Matches state names using glob-like pattern strings.</p>
+            <p>Globs can be used in specific APIs including:</p>
+            <ul>
+              <li>[[<a href="http://StateService.is">StateService.is</a>]]</li>
+              <li>[[StateService.includes]]</li>
+              <li>
+                The first argument to Hook Registration functions like
+                [[TransitionService.onStart]]
+                <ul>
+                  <li>[[HookMatchCriteria]] and [[HookMatchCriterion]]</li>
+                </ul>
+              </li>
+            </ul>
+            <p>
+              A <code>Glob</code> string is a pattern which matches state names.
+              Nested state names are split into segments (separated by a dot)
+              when processing. The state named <code>foo.bar.baz</code> is split
+              into three segments ['foo', 'bar', 'baz']
+            </p>
+            <p>Globs work according to the following rules:</p>
+            <h3 id="exact-match" class="tsd-anchor-link">
+              Exact match:<a
+                href="#exact-match"
+                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 glob <code>'A.B'</code> matches the state named exactly
+              <code>'A.B'</code>.
+            </p>
+            <table>
+              <thead>
+                <tr>
+                  <th style="text-align: left">Glob</th>
+                  <th style="text-align: left">Matches states named</th>
+                  <th style="text-align: left">Does not match state named</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td style="text-align: left"><code>'A'</code></td>
+                  <td style="text-align: left"><code>'A'</code></td>
+                  <td style="text-align: left">
+                    <code>'B'</code> , <code>'A.C'</code>
+                  </td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'A.B'</code></td>
+                  <td style="text-align: left"><code>'A.B'</code></td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'A.B.C'</code>
+                  </td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'foo'</code></td>
+                  <td style="text-align: left"><code>'foo'</code></td>
+                  <td style="text-align: left">
+                    <code>'FOO'</code> , <code>'foo.bar'</code>
+                  </td>
+                </tr>
+              </tbody>
+            </table>
+            <h3 id="single-star-" class="tsd-anchor-link">
+              Single star (<code>*</code>)<a
+                href="#single-star-"
+                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>
+              A single star (<code>*</code>) is a wildcard that matches exactly
+              one segment.
+            </p>
+            <table>
+              <thead>
+                <tr>
+                  <th style="text-align: left">Glob</th>
+                  <th style="text-align: left">Matches states named</th>
+                  <th style="text-align: left">Does not match state named</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td style="text-align: left"><code>'*'</code></td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'Z'</code>
+                  </td>
+                  <td style="text-align: left">
+                    <code>'A.B'</code> , <code>'Z.Y.X'</code>
+                  </td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'A.*'</code></td>
+                  <td style="text-align: left">
+                    <code>'A.B'</code> , <code>'A.C'</code>
+                  </td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'A.B.C'</code>
+                  </td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'A.*.*'</code></td>
+                  <td style="text-align: left">
+                    <code>'A.B.C'</code> , <code>'A.X.Y'</code>
+                  </td>
+                  <td style="text-align: left">
+                    <code>'A'</code>, <code>'A.B'</code> , <code>'Z.Y.X'</code>
+                  </td>
+                </tr>
+              </tbody>
+            </table>
+            <h3 id="double-star-" class="tsd-anchor-link">
+              Double star (<code>**</code>)<a
+                href="#double-star-"
+                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>
+              A double star (<code>'**'</code>) is a wildcard that matches
+              <em>zero or more segments</em>
+            </p>
+            <table>
+              <thead>
+                <tr>
+                  <th style="text-align: left">Glob</th>
+                  <th style="text-align: left">Matches states named</th>
+                  <th style="text-align: left">Does not match state named</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td style="text-align: left"><code>'**'</code></td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'A.B'</code>, <code>'Z.Y.X'</code>
+                  </td>
+                  <td style="text-align: left">(matches all states)</td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'A.**'</code></td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'A.B'</code> , <code>'A.C.X'</code>
+                  </td>
+                  <td style="text-align: left"><code>'Z.Y.X'</code></td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'**.X'</code></td>
+                  <td style="text-align: left">
+                    <code>'X'</code> , <code>'A.X'</code> , <code>'Z.Y.X'</code>
+                  </td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'A.login.Z'</code>
+                  </td>
+                </tr>
+                <tr>
+                  <td style="text-align: left"><code>'A.**.X'</code></td>
+                  <td style="text-align: left">
+                    <code>'A.X'</code> , <code>'A.B.X'</code> ,
+                    <code>'A.B.C.X'</code>
+                  </td>
+                  <td style="text-align: left">
+                    <code>'A'</code> , <code>'A.B.C'</code>
+                  </td>
+                </tr>
+              </tbody>
+            </table>
+          </div>
+          <div class="tsd-comment tsd-typography"></div>
+        </section>
         <section class="tsd-panel-group tsd-index-group">
           <section class="tsd-panel tsd-index-panel">
             <details class="tsd-index-content tsd-accordion" open>
@@ -190,15 +354,6 @@
                         <use href="../assets/icons.svg#icon-2048"></use></svg
                       ><span>from<wbr />String</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>
@@ -244,7 +399,7 @@
                     ><span class="tsd-signature-symbol">(</span
                     ><span class="tsd-kind-parameter">text</span
                     ><span class="tsd-signature-symbol">:</span>
-                    <span class="tsd-signature-type">any</span
+                    <span class="tsd-signature-type">string</span
                     ><span class="tsd-signature-symbol">)</span
                     ><span class="tsd-signature-symbol">:</span>
                     <a href="" class="tsd-signature-type tsd-kind-class">Glob</a
@@ -263,8 +418,9 @@
                         <li>
                           <span
                             ><span class="tsd-kind-parameter">text</span>:
-                            <span class="tsd-signature-type">any</span></span
+                            <span class="tsd-signature-type">string</span></span
                           >
+                          <div class="tsd-comment tsd-typography"></div>
                         </li>
                       </ul>
                     </div>
@@ -274,17 +430,7 @@
                         >Glob</a
                       >
                     </h4>
-                    <aside class="tsd-sources">
-                      <ul>
-                        <li>
-                          Defined in
-                          <a
-                            href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L59"
-                            >router/common/glob.js:59</a
-                          >
-                        </li>
-                      </ul>
-                    </aside>
+                    <div class="tsd-comment tsd-typography"></div>
                   </div>
                 </li>
               </ul>
@@ -316,19 +462,10 @@
               <div class="tsd-signature">
                 <span class="tsd-kind-property">glob</span
                 ><span class="tsd-signature-symbol">:</span>
-                <span class="tsd-signature-type">any</span>
+                <span class="tsd-signature-type">string</span
+                ><span class="tsd-signature-symbol">[]</span>
               </div>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L61"
-                      >router/common/glob.js:61</a
-                    >
-                  </li>
-                </ul>
-              </aside>
+              <div class="tsd-comment tsd-typography"></div>
             </section>
             <section class="tsd-panel tsd-member">
               <h3 class="tsd-anchor-link" id="regexp">
@@ -346,17 +483,7 @@
                 ><span class="tsd-signature-symbol">:</span>
                 <span class="tsd-signature-type">RegExp</span>
               </div>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L70"
-                      >router/common/glob.js:70</a
-                    >
-                  </li>
-                </ul>
-              </aside>
+              <div class="tsd-comment tsd-typography"></div>
             </section>
             <section class="tsd-panel tsd-member">
               <h3 class="tsd-anchor-link" id="text">
@@ -369,19 +496,9 @@
               <div class="tsd-signature">
                 <span class="tsd-kind-property">text</span
                 ><span class="tsd-signature-symbol">:</span>
-                <span class="tsd-signature-type">any</span>
+                <span class="tsd-signature-type">string</span>
               </div>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L60"
-                      >router/common/glob.js:60</a
-                    >
-                  </li>
-                </ul>
-              </aside>
+              <div class="tsd-comment tsd-typography"></div>
             </section>
           </section>
         </details>
@@ -444,17 +561,6 @@
                     <h4 class="tsd-returns-title">
                       Returns <span class="tsd-signature-type">boolean</span>
                     </h4>
-                    <aside class="tsd-sources">
-                      <ul>
-                        <li>
-                          Defined in
-                          <a
-                            href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L72"
-                            >router/common/glob.js:72</a
-                          >
-                        </li>
-                      </ul>
-                    </aside>
                   </div>
                 </li>
               </ul>
@@ -477,7 +583,7 @@
                     ><span class="tsd-signature-symbol">(</span
                     ><span class="tsd-kind-parameter">text</span
                     ><span class="tsd-signature-symbol">:</span>
-                    <span class="tsd-signature-type">any</span
+                    <span class="tsd-signature-type">string</span
                     ><span class="tsd-signature-symbol">)</span
                     ><span class="tsd-signature-symbol">:</span>
                     <a href="" class="tsd-signature-type tsd-kind-class">Glob</a
@@ -502,8 +608,9 @@
                         <li>
                           <span
                             ><span class="tsd-kind-parameter">text</span>:
-                            <span class="tsd-signature-type">any</span></span
+                            <span class="tsd-signature-type">string</span></span
                           >
+                          <div class="tsd-comment tsd-typography"></div>
                         </li>
                       </ul>
                     </div>
@@ -514,81 +621,6 @@
                       >
                     </h4>
                     <div class="tsd-comment tsd-typography"></div>
-                    <aside class="tsd-sources">
-                      <ul>
-                        <li>
-                          Defined in
-                          <a
-                            href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L56"
-                            >router/common/glob.js:56</a
-                          >
-                        </li>
-                      </ul>
-                    </aside>
-                  </div>
-                </li>
-              </ul>
-            </section>
-            <section class="tsd-panel tsd-member">
-              <h3 class="tsd-anchor-link" id="is">
-                <code class="tsd-tag">Static</code><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">text</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="#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>
-                        Returns true if the string has glob-like characters in
-                        it
-                      </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">text</span>:
-                            <span class="tsd-signature-type">any</span></span
-                          >
-                        </li>
-                      </ul>
-                    </div>
-                    <h4 class="tsd-returns-title">
-                      Returns <span class="tsd-signature-type">boolean</span>
-                    </h4>
-                    <div class="tsd-comment tsd-typography"></div>
-                    <aside class="tsd-sources">
-                      <ul>
-                        <li>
-                          Defined in
-                          <a
-                            href="https://github.com/Angular-Wave/angular.ts/blob/313b293606259c262c2eb31fddf6a3bc26b2ca23/src/router/common/glob.js#L52"
-                            >router/common/glob.js:52</a
-                          >
-                        </li>
-                      </ul>
-                    </aside>
                   </div>
                 </li>
               </ul>
@@ -740,6 +772,9 @@
               <h3>On This Page</h3>
             </summary>
             <div class="tsd-accordion-details">
+              <a href="#exact-match"><span>Exact match:</span></a
+              ><a href="#single-star-"><span>Single star (*)</span></a
+              ><a href="#double-star-"><span>Double star (**)</span></a>
               <details open class="tsd-accordion tsd-page-navigation-section">
                 <summary
                   class="tsd-accordion-summary"
@@ -842,14 +877,6 @@
                     >
                       <use href="../assets/icons.svg#icon-2048"></use></svg
                     ><span>from<wbr />String</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>
@@ -858,7 +885,7 @@
         </div>
         <div class="site-menu">
           <nav class="tsd-navigation">
-            <a href="../modules.html">@angular-wave/angular.ts</a>
+            <a href="../modules.html">AngularTS</a>
             <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
               <li>Loading...</li>
             </ul>