@angular-wave/angular.ts 0.0.37 → 0.0.39

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

@@ -2,275 +2,270 @@
  * API for URL management
  */
 export class UrlService {
-  static $inject: string[];
-  /**
-   * @param {angular.ILocationProvider} $locationProvider
-   */
-  constructor(
-    $locationProvider: angular.ILocationProvider,
-    stateService: any,
-    globals: any,
-    urlConfigProvider: any,
-  );
-  stateService: any;
-  $locationProvider: angular.ILocationProvider;
-  $location: any;
-  $browser: any;
-  /** @type {boolean} */
-  interceptDeferred: boolean;
-  /** Provides services related to the URL */
-  urlRuleFactory: UrlRuleFactory;
-  /**
-   * The nested [[UrlRules]] API for managing URL rules and rewrites
-   *
-   * See: [[UrlRules]] for details
-   * @type {UrlRules}
-   */
-  rules: UrlRules;
-  /**
-   * The nested [[UrlConfig]] API to configure the URL and retrieve URL information
-   *
-   * See: [[UrlConfig]] for details
-   * @type {angular.UrlConfig}
-   */
-  config: angular.UrlConfig;
-  /** Creates a new [[Param]] for a given location (DefType) */
-  paramFactory: ParamFactory;
-  /**
-   * Gets the path part of the current url
-   *
-   * If the current URL is `/some/path?query=value#anchor`, this returns `/some/path`
-   *
-   * @return the path portion of the url
-   */
-  path: () => any;
-  /**
-   * Gets the search part of the current url as an object
-   *
-   * If the current URL is `/some/path?query=value#anchor`, this returns `{ query: 'value' }`
-   *
-   * @return the search (query) portion of the url, as an object
-   */
-  search: () => any;
-  /**
-   * Gets the hash part of the current url
-   *
-   * If the current URL is `/some/path?query=value#anchor`, this returns `anchor`
-   *
-   * @return the hash (anchor) portion of the url
-   */
-  hash: () => any;
-  _urlListeners: any[];
-  $get: (string | (($location: any, $browser: any, $rootScope: any) => this))[];
-  html5Mode(): boolean;
-  baseHref(): any;
-  _baseHref: any;
-  /**
-   * Gets the current url, or updates the url
-   *
-   * ### Getting the current URL
-   *
-   * When no arguments are passed, returns the current URL.
-   * The URL is normalized using the internal [[path]]/[[search]]/[[hash]] values.
-   *
-   * For example, the URL may be stored in the hash ([[HashLocationServices]]) or
-   * have a base HREF prepended ([[PushStateLocationServices]]).
-   *
-   * The raw URL in the browser might be:
-   *
-   * ```
-   * http://mysite.com/somepath/index.html#/internal/path/123?param1=foo#anchor
-   * ```
-   *
-   * or
-   *
-   * ```
-   * http://mysite.com/basepath/internal/path/123?param1=foo#anchor
-   * ```
-   *
-   * then this method returns:
-   *
-   * ```
-   * /internal/path/123?param1=foo#anchor
-   * ```
-   *
-   *
-   * #### Example:
-   * ```js
-   * locationServices.url(); // "/some/path?query=value#anchor"
-   * ```
-   *
-   * ### Updating the URL
-   *
-   * When `newurl` arguments is provided, changes the URL to reflect `newurl`
-   *
-   * #### Example:
-   * ```js
-   * locationServices.url("/some/path?query=value#anchor", true);
-   * ```
-   *
-   * @param {string} newUrl The new value for the URL.
-   *               This url should reflect only the new internal [[path]], [[search]], and [[hash]] values.
-   *               It should not include the protocol, site, port, or base path of an absolute HREF.
-   * @param {boolean} replace When true, replaces the current history entry (instead of appending it) with this new url
-   * @param {any} state The history's state object, i.e., pushState (if the LocationServices implementation supports it)
-   *
-   * @return the url (after potentially being processed)
-   */
-  url(newUrl: string, replace: boolean, state: any): any;
-  /**
-   * @internal
-   *
-   * Registers a low level url change handler
-   *
-   * Note: Because this is a low level handler, it's not recommended for general use.
-   *
-   * #### Example:
-   * ```js
-   * let deregisterFn = locationServices.onChange((evt) => console.log("url change", evt));
-   * ```
-   *
-   * @param callback a function that will be called when the url is changing
-   * @return a function that de-registers the callback
-   */
-  onChange(callback: any): () => any;
-  /**
-   * Gets the current URL parts
-   *
-   * This method returns the different parts of the current URL (the [[path]], [[search]], and [[hash]]) as a [[UrlParts]] object.
-   */
-  parts(): {
-    path: any;
-    search: any;
-    hash: any;
-  };
-  /**
-   * Activates the best rule for the current URL
-   *
-   * Checks the current URL for a matching [[UrlRule]], then invokes that rule's handler.
-   * This method is called internally any time the URL has changed.
-   *
-   * This effectively activates the state (or redirect, etc) which matches the current URL.
-   *
-   * #### Example:
-   * ```js
-   * urlService.deferIntercept();
-   *
-   * fetch('/states.json').then(resp => resp.json()).then(data => {
-   *   data.forEach(state => $stateRegistry.register(state));
-   *   urlService.listen();
-   *   // Find the matching URL and invoke the handler.
-   *   urlService.sync();
-   * });
-   * ```
-   */
-  sync(evt: any): void;
-  /**
-   * Starts or stops listening for URL changes
-   *
-   * Call this sometime after calling [[deferIntercept]] to start monitoring the url.
-   * This causes ng-router to start listening for changes to the URL, if it wasn't already listening.
-   *
-   * If called with `false`, ng-router will stop listening (call listen(true) to start listening again).
-   *
-   * #### Example:
-   * ```js
-   * urlService.deferIntercept();
-   *
-   * fetch('/states.json').then(resp => resp.json()).then(data => {
-   *   data.forEach(state => $stateRegistry.register(state));
-   *   // Start responding to URL changes
-   *   urlService.listen();
-   *   urlService.sync();
-   * });
-   * ```
-   *
-   * @param enabled `true` or `false` to start or stop listening to URL changes
-   */
-  listen(enabled: any): any;
-  _stopListeningFn: any;
-  /**
-   * Disables monitoring of the URL.
-   *
-   * Call this method before ng-router has bootstrapped.
-   * It will stop ng-router from performing the initial url sync.
-   *
-   * This can be useful to perform some asynchronous initialization before the router starts.
-   * Once the initialization is complete, call [[listen]] to tell ng-router to start watching and synchronizing the URL.
-   *
-   * #### Example:
-   * ```js
-   * // Prevent ng-router from automatically intercepting URL changes when it starts;
-   * urlService.deferIntercept();
-   *
-   * fetch('/states.json').then(resp => resp.json()).then(data => {
-   *   data.forEach(state => $stateRegistry.register(state));
-   *   urlService.listen();
-   *   urlService.sync();
-   * });
-   * ```
-   *
-   * @param defer Indicates whether to defer location change interception.
-   *        Passing no parameter is equivalent to `true`.
-   */
-  deferIntercept(defer: any): void;
-  /**
-   * Matches a URL
-   *
-   * Given a URL (as a [[UrlParts]] object), check all rules and determine the best matching rule.
-   * Return the result as a [[MatchResult]].
-   * @returns {angular.MatchResult}
-   */
-  match(url: any): angular.MatchResult;
-  update(read: any): void;
-  location: any;
-  /**
-   * Internal API.
-   *
-   * Pushes a new location to the browser history.
-   *
-   * @internal
-   * @param urlMatcher
-   * @param params
-   * @param options
-   */
-  push(urlMatcher: any, params: any, options: any): void;
-  /**
-   * Builds and returns a URL with interpolated parameters
-   *
-   * #### Example:
-   * ```js
-   * matcher = $umf.compile("/about/:person");
-   * params = { person: "bob" };
-   * $bob = $urlService.href(matcher, params);
-   * // $bob == "/about/bob";
-   * ```
-   *
-   * @param urlMatcher The [[UrlMatcher]] object which is used as the template of the URL to generate.
-   * @param params An object of parameter values to fill the matcher's required parameters.
-   * @param options Options object. The options are:
-   *
-   * - **`absolute`** - {boolean=false},  If true will generate an absolute url, e.g. "http://www.example.com/fullurl".
-   *
-   * @returns Returns the fully compiled URL, or `null` if `params` fail validation against `urlMatcher`
-   */
-  href(urlMatcher: any, params: any, options: any): any;
-  /**
-   * Creates a [[UrlMatcher]] for the specified pattern.
-   *
-   * @param pattern  The URL pattern.
-   * @param config  The config object hash.
-   * @returns The UrlMatcher.
-   */
-  compile(pattern: any, config: any): UrlMatcher;
-  /**
-   * Returns true if the specified object is a [[UrlMatcher]], or false otherwise.
-   *
-   * @param object  The object to perform the type check against.
-   * @returns `true` if the object matches the `UrlMatcher` interface, by
-   *          implementing all the same methods.
-   */
-  isMatcher(object: any): boolean;
+    static $inject: string[];
+    /**
+     * @param {angular.ILocationProvider} $locationProvider
+     */
+    constructor($locationProvider: angular.ILocationProvider, stateService: any, globals: any, urlConfigProvider: any);
+    stateService: any;
+    $locationProvider: angular.ILocationProvider;
+    $location: any;
+    $browser: any;
+    /** @type {boolean} */
+    interceptDeferred: boolean;
+    /** Provides services related to the URL */
+    urlRuleFactory: UrlRuleFactory;
+    /**
+     * The nested [[UrlRules]] API for managing URL rules and rewrites
+     *
+     * See: [[UrlRules]] for details
+     * @type {UrlRules}
+     */
+    rules: UrlRules;
+    /**
+     * The nested [[UrlConfig]] API to configure the URL and retrieve URL information
+     *
+     * See: [[UrlConfig]] for details
+     * @type {angular.UrlConfig}
+     */
+    config: angular.UrlConfig;
+    /** Creates a new [[Param]] for a given location (DefType) */
+    paramFactory: ParamFactory;
+    /**
+     * Gets the path part of the current url
+     *
+     * If the current URL is `/some/path?query=value#anchor`, this returns `/some/path`
+     *
+     * @return the path portion of the url
+     */
+    path: () => any;
+    /**
+     * Gets the search part of the current url as an object
+     *
+     * If the current URL is `/some/path?query=value#anchor`, this returns `{ query: 'value' }`
+     *
+     * @return the search (query) portion of the url, as an object
+     */
+    search: () => any;
+    /**
+     * Gets the hash part of the current url
+     *
+     * If the current URL is `/some/path?query=value#anchor`, this returns `anchor`
+     *
+     * @return the hash (anchor) portion of the url
+     */
+    hash: () => any;
+    _urlListeners: any[];
+    $get: (string | (($location: any, $browser: any, $rootScope: any) => this))[];
+    html5Mode(): boolean;
+    baseHref(): any;
+    _baseHref: any;
+    /**
+     * Gets the current url, or updates the url
+     *
+     * ### Getting the current URL
+     *
+     * When no arguments are passed, returns the current URL.
+     * The URL is normalized using the internal [[path]]/[[search]]/[[hash]] values.
+     *
+     * For example, the URL may be stored in the hash ([[HashLocationServices]]) or
+     * have a base HREF prepended ([[PushStateLocationServices]]).
+     *
+     * The raw URL in the browser might be:
+     *
+     * ```
+     * http://mysite.com/somepath/index.html#/internal/path/123?param1=foo#anchor
+     * ```
+     *
+     * or
+     *
+     * ```
+     * http://mysite.com/basepath/internal/path/123?param1=foo#anchor
+     * ```
+     *
+     * then this method returns:
+     *
+     * ```
+     * /internal/path/123?param1=foo#anchor
+     * ```
+     *
+     *
+     * #### Example:
+     * ```js
+     * locationServices.url(); // "/some/path?query=value#anchor"
+     * ```
+     *
+     * ### Updating the URL
+     *
+     * When `newurl` arguments is provided, changes the URL to reflect `newurl`
+     *
+     * #### Example:
+     * ```js
+     * locationServices.url("/some/path?query=value#anchor", true);
+     * ```
+     *
+     * @param {string} newUrl The new value for the URL.
+     *               This url should reflect only the new internal [[path]], [[search]], and [[hash]] values.
+     *               It should not include the protocol, site, port, or base path of an absolute HREF.
+     * @param {boolean} replace When true, replaces the current history entry (instead of appending it) with this new url
+     * @param {any} state The history's state object, i.e., pushState (if the LocationServices implementation supports it)
+     *
+     * @return the url (after potentially being processed)
+     */
+    url(newUrl: string, replace: boolean, state: any): any;
+    /**
+     * @internal
+     *
+     * Registers a low level url change handler
+     *
+     * Note: Because this is a low level handler, it's not recommended for general use.
+     *
+     * #### Example:
+     * ```js
+     * let deregisterFn = locationServices.onChange((evt) => console.log("url change", evt));
+     * ```
+     *
+     * @param callback a function that will be called when the url is changing
+     * @return a function that de-registers the callback
+     */
+    onChange(callback: any): () => any;
+    /**
+     * Gets the current URL parts
+     *
+     * This method returns the different parts of the current URL (the [[path]], [[search]], and [[hash]]) as a [[UrlParts]] object.
+     */
+    parts(): {
+        path: any;
+        search: any;
+        hash: any;
+    };
+    /**
+     * Activates the best rule for the current URL
+     *
+     * Checks the current URL for a matching [[UrlRule]], then invokes that rule's handler.
+     * This method is called internally any time the URL has changed.
+     *
+     * This effectively activates the state (or redirect, etc) which matches the current URL.
+     *
+     * #### Example:
+     * ```js
+     * urlService.deferIntercept();
+     *
+     * fetch('/states.json').then(resp => resp.json()).then(data => {
+     *   data.forEach(state => $stateRegistry.register(state));
+     *   urlService.listen();
+     *   // Find the matching URL and invoke the handler.
+     *   urlService.sync();
+     * });
+     * ```
+     */
+    sync(evt: any): void;
+    /**
+     * Starts or stops listening for URL changes
+     *
+     * Call this sometime after calling [[deferIntercept]] to start monitoring the url.
+     * This causes ng-router to start listening for changes to the URL, if it wasn't already listening.
+     *
+     * If called with `false`, ng-router will stop listening (call listen(true) to start listening again).
+     *
+     * #### Example:
+     * ```js
+     * urlService.deferIntercept();
+     *
+     * fetch('/states.json').then(resp => resp.json()).then(data => {
+     *   data.forEach(state => $stateRegistry.register(state));
+     *   // Start responding to URL changes
+     *   urlService.listen();
+     *   urlService.sync();
+     * });
+     * ```
+     *
+     * @param enabled `true` or `false` to start or stop listening to URL changes
+     */
+    listen(enabled: any): any;
+    _stopListeningFn: any;
+    /**
+     * Disables monitoring of the URL.
+     *
+     * Call this method before ng-router has bootstrapped.
+     * It will stop ng-router from performing the initial url sync.
+     *
+     * This can be useful to perform some asynchronous initialization before the router starts.
+     * Once the initialization is complete, call [[listen]] to tell ng-router to start watching and synchronizing the URL.
+     *
+     * #### Example:
+     * ```js
+     * // Prevent ng-router from automatically intercepting URL changes when it starts;
+     * urlService.deferIntercept();
+     *
+     * fetch('/states.json').then(resp => resp.json()).then(data => {
+     *   data.forEach(state => $stateRegistry.register(state));
+     *   urlService.listen();
+     *   urlService.sync();
+     * });
+     * ```
+     *
+     * @param defer Indicates whether to defer location change interception.
+     *        Passing no parameter is equivalent to `true`.
+     */
+    deferIntercept(defer: any): void;
+    /**
+     * Matches a URL
+     *
+     * Given a URL (as a [[UrlParts]] object), check all rules and determine the best matching rule.
+     * Return the result as a [[MatchResult]].
+     * @returns {angular.MatchResult}
+     */
+    match(url: any): angular.MatchResult;
+    update(read: any): void;
+    location: any;
+    /**
+     * Internal API.
+     *
+     * Pushes a new location to the browser history.
+     *
+     * @internal
+     * @param urlMatcher
+     * @param params
+     * @param options
+     */
+    push(urlMatcher: any, params: any, options: any): void;
+    /**
+     * Builds and returns a URL with interpolated parameters
+     *
+     * #### Example:
+     * ```js
+     * matcher = $umf.compile("/about/:person");
+     * params = { person: "bob" };
+     * $bob = $urlService.href(matcher, params);
+     * // $bob == "/about/bob";
+     * ```
+     *
+     * @param urlMatcher The [[UrlMatcher]] object which is used as the template of the URL to generate.
+     * @param params An object of parameter values to fill the matcher's required parameters.
+     * @param options Options object. The options are:
+     *
+     * - **`absolute`** - {boolean=false},  If true will generate an absolute url, e.g. "http://www.example.com/fullurl".
+     *
+     * @returns Returns the fully compiled URL, or `null` if `params` fail validation against `urlMatcher`
+     */
+    href(urlMatcher: any, params: any, options: any): any;
+    /**
+     * Creates a [[UrlMatcher]] for the specified pattern.
+     *
+     * @param pattern  The URL pattern.
+     * @param config  The config object hash.
+     * @returns The UrlMatcher.
+     */
+    compile(pattern: any, config: any): UrlMatcher;
+    /**
+     * Returns true if the specified object is a [[UrlMatcher]], or false otherwise.
+     *
+     * @param object  The object to perform the type check against.
+     * @returns `true` if the object matches the `UrlMatcher` interface, by
+     *          implementing all the same methods.
+     */
+    isMatcher(object: any): boolean;
 }
 import { UrlRuleFactory } from "./url-rule";
 import { UrlRules } from "./url-rules";