@angular-wave/angular.ts 0.0.38 → 0.0.40

package/types/router/url/url-rule.d.ts

@@ -9,126 +9,116 @@
  * - [[StateObject]]
  */
 export class UrlRuleFactory {
-  constructor(urlService: any, stateService: any, routerGlobals: any);
-  urlService: any;
-  stateService: any;
-  routerGlobals: any;
-  /**
-   *
-   * @param {*} what
-   * @param {*} handler
-   * @returns {BaseUrlRule}
-   */
-  create(what: any, handler: any): BaseUrlRule;
-  /**
-   * A UrlRule which matches based on a UrlMatcher
-   *
-   * The `handler` may be either a `string`, a [[UrlRuleHandlerFn]] or another [[UrlMatcher]]
-   *
-   * ## Handler as a function
-   *
-   * If `handler` is a function, the function is invoked with:
-   *
-   * - matched parameter values ([[RawParams]] from [[UrlMatcher.exec]])
-   * - url: the current Url ([[UrlParts]])
-   * - router: the router object ([[UIRouter]])
-   *
-   * #### Example:
-   * ```js
-   * var urlMatcher = $umf.compile("/foo/:fooId/:barId");
-   * var rule = factory.fromUrlMatcher(urlMatcher, match => "/home/" + match.fooId + "/" + match.barId);
-   * var match = rule.match('/foo/123/456'); // results in { fooId: '123', barId: '456' }
-   * var result = rule.handler(match); // '/home/123/456'
-   * ```
-   *
-   * ## Handler as UrlMatcher
-   *
-   * If `handler` is a UrlMatcher, the handler matcher is used to create the new url.
-   * The `handler` UrlMatcher is formatted using the matched param from the first matcher.
-   * The url is replaced with the result.
-   *
-   * #### Example:
-   * ```js
-   * var urlMatcher = $umf.compile("/foo/:fooId/:barId");
-   * var handler = $umf.compile("/home/:fooId/:barId");
-   * var rule = factory.fromUrlMatcher(urlMatcher, handler);
-   * var match = rule.match('/foo/123/456'); // results in { fooId: '123', barId: '456' }
-   * var result = rule.handler(match); // '/home/123/456'
-   * ```
-   */
-  fromUrlMatcher(
-    urlMatcher: any,
-    handler: any,
-  ): BaseUrlRule & {
-    urlMatcher: any;
-    matchPriority: (params: any) => number;
-    type: string;
-  };
-  /**
-   * A UrlRule which matches a state by its url
-   *
-   * #### Example:
-   * ```js
-   * var rule = factory.fromState($state.get('foo'), router);
-   * var match = rule.match('/foo/123/456'); // results in { fooId: '123', barId: '456' }
-   * var result = rule.handler(match);
-   * // Starts a transition to 'foo' with params: { fooId: '123', barId: '456' }
-   * ```
-   */
-  fromState(
-    stateOrDecl: any,
-    stateService: any,
-    globals: any,
-  ): BaseUrlRule & {
-    urlMatcher: any;
-    matchPriority: (params: any) => number;
-    type: string;
-  } & {
-    state: any;
-    type: string;
-  };
-  /**
-   * A UrlRule which matches based on a regular expression
-   *
-   * The `handler` may be either a [[UrlRuleHandlerFn]] or a string.
-   *
-   * ## Handler as a function
-   *
-   * If `handler` is a function, the function is invoked with:
-   *
-   * - regexp match array (from `regexp`)
-   * - url: the current Url ([[UrlParts]])
-   * - router: the router object ([[UIRouter]])
-   *
-   * #### Example:
-   * ```js
-   * var rule = factory.fromRegExp(/^\/foo\/(bar|baz)$/, match => "/home/" + match[1])
-   * var match = rule.match('/foo/bar'); // results in [ '/foo/bar', 'bar' ]
-   * var result = rule.handler(match); // '/home/bar'
-   * ```
-   *
-   * ## Handler as string
-   *
-   * If `handler` is a string, the url is *replaced by the string* when the Rule is invoked.
-   * The string is first interpolated using `string.replace()` style pattern.
-   *
-   * #### Example:
-   * ```js
-   * var rule = factory.fromRegExp(/^\/foo\/(bar|baz)$/, "/home/$1")
-   * var match = rule.match('/foo/bar'); // results in [ '/foo/bar', 'bar' ]
-   * var result = rule.handler(match); // '/home/bar'
-   * ```
-   */
-  fromRegExp(
-    regexp: any,
-    handler: any,
-  ): BaseUrlRule & {
-    regexp: any;
-    type: string;
-  };
+    constructor(urlService: any, stateService: any, routerGlobals: any);
+    urlService: any;
+    stateService: any;
+    routerGlobals: any;
+    /**
+     *
+     * @param {*} what
+     * @param {*} handler
+     * @returns {BaseUrlRule}
+     */
+    create(what: any, handler: any): BaseUrlRule;
+    /**
+     * A UrlRule which matches based on a UrlMatcher
+     *
+     * The `handler` may be either a `string`, a [[UrlRuleHandlerFn]] or another [[UrlMatcher]]
+     *
+     * ## Handler as a function
+     *
+     * If `handler` is a function, the function is invoked with:
+     *
+     * - matched parameter values ([[RawParams]] from [[UrlMatcher.exec]])
+     * - url: the current Url ([[UrlParts]])
+     * - router: the router object ([[UIRouter]])
+     *
+     * #### Example:
+     * ```js
+     * var urlMatcher = $umf.compile("/foo/:fooId/:barId");
+     * var rule = factory.fromUrlMatcher(urlMatcher, match => "/home/" + match.fooId + "/" + match.barId);
+     * var match = rule.match('/foo/123/456'); // results in { fooId: '123', barId: '456' }
+     * var result = rule.handler(match); // '/home/123/456'
+     * ```
+     *
+     * ## Handler as UrlMatcher
+     *
+     * If `handler` is a UrlMatcher, the handler matcher is used to create the new url.
+     * The `handler` UrlMatcher is formatted using the matched param from the first matcher.
+     * The url is replaced with the result.
+     *
+     * #### Example:
+     * ```js
+     * var urlMatcher = $umf.compile("/foo/:fooId/:barId");
+     * var handler = $umf.compile("/home/:fooId/:barId");
+     * var rule = factory.fromUrlMatcher(urlMatcher, handler);
+     * var match = rule.match('/foo/123/456'); // results in { fooId: '123', barId: '456' }
+     * var result = rule.handler(match); // '/home/123/456'
+     * ```
+     */
+    fromUrlMatcher(urlMatcher: any, handler: any): BaseUrlRule & {
+        urlMatcher: any;
+        matchPriority: (params: any) => number;
+        type: string;
+    };
+    /**
+     * A UrlRule which matches a state by its url
+     *
+     * #### Example:
+     * ```js
+     * var rule = factory.fromState($state.get('foo'), router);
+     * var match = rule.match('/foo/123/456'); // results in { fooId: '123', barId: '456' }
+     * var result = rule.handler(match);
+     * // Starts a transition to 'foo' with params: { fooId: '123', barId: '456' }
+     * ```
+     */
+    fromState(stateOrDecl: any, stateService: any, globals: any): BaseUrlRule & {
+        urlMatcher: any;
+        matchPriority: (params: any) => number;
+        type: string;
+    } & {
+        state: any;
+        type: string;
+    };
+    /**
+     * A UrlRule which matches based on a regular expression
+     *
+     * The `handler` may be either a [[UrlRuleHandlerFn]] or a string.
+     *
+     * ## Handler as a function
+     *
+     * If `handler` is a function, the function is invoked with:
+     *
+     * - regexp match array (from `regexp`)
+     * - url: the current Url ([[UrlParts]])
+     * - router: the router object ([[UIRouter]])
+     *
+     * #### Example:
+     * ```js
+     * var rule = factory.fromRegExp(/^\/foo\/(bar|baz)$/, match => "/home/" + match[1])
+     * var match = rule.match('/foo/bar'); // results in [ '/foo/bar', 'bar' ]
+     * var result = rule.handler(match); // '/home/bar'
+     * ```
+     *
+     * ## Handler as string
+     *
+     * If `handler` is a string, the url is *replaced by the string* when the Rule is invoked.
+     * The string is first interpolated using `string.replace()` style pattern.
+     *
+     * #### Example:
+     * ```js
+     * var rule = factory.fromRegExp(/^\/foo\/(bar|baz)$/, "/home/$1")
+     * var match = rule.match('/foo/bar'); // results in [ '/foo/bar', 'bar' ]
+     * var result = rule.handler(match); // '/home/bar'
+     * ```
+     */
+    fromRegExp(regexp: any, handler: any): BaseUrlRule & {
+        regexp: any;
+        type: string;
+    };
 }
 export namespace UrlRuleFactory {
-  function isUrlRule(obj: any): boolean;
+    function isUrlRule(obj: any): boolean;
 }
 /**
  * A base rule which calls `match`
@@ -137,10 +127,10 @@ export namespace UrlRuleFactory {
  * @type {angular.BaseUrlRule}
  */
 export class BaseUrlRule {
-  constructor(match: any, handler: any);
-  match: any;
-  type: string;
-  $id: number;
-  matchPriority: () => number;
-  handler: any;
+    constructor(match: any, handler: any);
+    match: any;
+    type: string;
+    $id: number;
+    matchPriority: () => number;
+    handler: any;
 }