@angular-wave/angular.ts 0.0.37 → 0.0.39

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

@@ -12,89 +12,89 @@
  * This API is found at `router.urlService.config` (see: [[UIRouter.urlService]], [[URLService.config]])
  */
 export class UrlConfigProvider {
-  /** @type {ParamTypes} */
-  paramTypes: ParamTypes;
-  /** @type {boolean} */
-  _isCaseInsensitive: boolean;
-  /** @type {boolean} */
-  _isStrictMode: boolean;
-  /** @type {boolean} */
-  _defaultSquashPolicy: boolean;
-  $get: (() => any)[];
-  /**
-   * Defines whether URL matching should be case sensitive (the default behavior), or not.
-   *
-   * #### Example:
-   * ```js
-   * // Allow case insensitive url matches
-   * urlService.config.caseInsensitive(true);
-   * ```
-   *
-   * @param value `false` to match URL in a case sensitive manner; otherwise `true`;
-   * @returns the current value of caseInsensitive
-   */
-  caseInsensitive(value: any): any;
-  /**
-   * Sets the default behavior when generating or matching URLs with default parameter values.
-   *
-   * #### Example:
-   * ```js
-   * // Remove default parameter values from the url
-   * urlService.config.defaultSquashPolicy(true);
-   * ```
-   *
-   * @param value A string that defines the default parameter URL squashing behavior.
-   *    - `nosquash`: When generating an href with a default parameter value, do not squash the parameter value from the URL
-   *    - `slash`: When generating an href with a default parameter value, squash (remove) the parameter value, and, if the
-   *      parameter is surrounded by slashes, squash (remove) one slash from the URL
-   *    - any other string, e.g. "~": When generating an href with a default parameter value, squash (remove)
-   *      the parameter value from the URL and replace it with this string.
-   * @returns the current value of defaultSquashPolicy
-   */
-  defaultSquashPolicy(value: any): any;
-  /**
-   * Defines whether URLs should match trailing slashes, or not (the default behavior).
-   *
-   * #### Example:
-   * ```js
-   * // Allow optional trailing slashes
-   * urlService.config.strictMode(false);
-   * ```
-   *
-   * @param value `false` to match trailing slashes in URLs, otherwise `true`.
-   * @returns the current value of strictMode
-   */
-  strictMode(value: any): any;
-  /**
-   * Creates and registers a custom [[ParamType]] object
-   *
-   * A custom parameter type can be used to generate URLs with typed parameters or custom encoding/decoding.
-   *
-   * #### Note: Register custom types *before using them* in a state definition.
-   *
-   * #### Example:
-   * ```js
-   * // Encode object parameter as JSON string
-   * urlService.config.type('myjson', {
-   *   encode: (obj) => JSON.stringify(obj),
-   *   decode: (str) => JSON.parse(str),
-   *   is: (val) => typeof(val) === 'object',
-   *   pattern: /[^/]+/,
-   *   equals: (a, b) => _.isEqual(a, b),
-   * });
-   * ```
-   *
-   * See [[ParamTypeDefinition]] for more examples
-   *
-   * @param name The type name.
-   * @param definition The type definition. See [[ParamTypeDefinition]] for information on the values accepted.
-   * @param definitionFn A function that is injected before the app runtime starts.
-   *        The result of this function should be a [[ParamTypeDefinition]].
-   *        The result is merged into the existing `definition`.
-   *        See [[ParamType]] for information on the values accepted.
-   *
-   * @returns if only the `name` parameter was specified: the currently registered [[ParamType]] object, or undefined
-   */
-  type(name: any, definition: any, definitionFn: any): any;
+    /** @type {ParamTypes} */
+    paramTypes: ParamTypes;
+    /** @type {boolean} */
+    _isCaseInsensitive: boolean;
+    /** @type {boolean} */
+    _isStrictMode: boolean;
+    /** @type {boolean} */
+    _defaultSquashPolicy: boolean;
+    $get: (() => any)[];
+    /**
+     * Defines whether URL matching should be case sensitive (the default behavior), or not.
+     *
+     * #### Example:
+     * ```js
+     * // Allow case insensitive url matches
+     * urlService.config.caseInsensitive(true);
+     * ```
+     *
+     * @param value `false` to match URL in a case sensitive manner; otherwise `true`;
+     * @returns the current value of caseInsensitive
+     */
+    caseInsensitive(value: any): any;
+    /**
+     * Sets the default behavior when generating or matching URLs with default parameter values.
+     *
+     * #### Example:
+     * ```js
+     * // Remove default parameter values from the url
+     * urlService.config.defaultSquashPolicy(true);
+     * ```
+     *
+     * @param value A string that defines the default parameter URL squashing behavior.
+     *    - `nosquash`: When generating an href with a default parameter value, do not squash the parameter value from the URL
+     *    - `slash`: When generating an href with a default parameter value, squash (remove) the parameter value, and, if the
+     *      parameter is surrounded by slashes, squash (remove) one slash from the URL
+     *    - any other string, e.g. "~": When generating an href with a default parameter value, squash (remove)
+     *      the parameter value from the URL and replace it with this string.
+     * @returns the current value of defaultSquashPolicy
+     */
+    defaultSquashPolicy(value: any): any;
+    /**
+     * Defines whether URLs should match trailing slashes, or not (the default behavior).
+     *
+     * #### Example:
+     * ```js
+     * // Allow optional trailing slashes
+     * urlService.config.strictMode(false);
+     * ```
+     *
+     * @param value `false` to match trailing slashes in URLs, otherwise `true`.
+     * @returns the current value of strictMode
+     */
+    strictMode(value: any): any;
+    /**
+     * Creates and registers a custom [[ParamType]] object
+     *
+     * A custom parameter type can be used to generate URLs with typed parameters or custom encoding/decoding.
+     *
+     * #### Note: Register custom types *before using them* in a state definition.
+     *
+     * #### Example:
+     * ```js
+     * // Encode object parameter as JSON string
+     * urlService.config.type('myjson', {
+     *   encode: (obj) => JSON.stringify(obj),
+     *   decode: (str) => JSON.parse(str),
+     *   is: (val) => typeof(val) === 'object',
+     *   pattern: /[^/]+/,
+     *   equals: (a, b) => _.isEqual(a, b),
+     * });
+     * ```
+     *
+     * See [[ParamTypeDefinition]] for more examples
+     *
+     * @param name The type name.
+     * @param definition The type definition. See [[ParamTypeDefinition]] for information on the values accepted.
+     * @param definitionFn A function that is injected before the app runtime starts.
+     *        The result of this function should be a [[ParamTypeDefinition]].
+     *        The result is merged into the existing `definition`.
+     *        See [[ParamType]] for information on the values accepted.
+     *
+     * @returns if only the `name` parameter was specified: the currently registered [[ParamType]] object, or undefined
+     */
+    type(name: any, definition: any, definitionFn: any): any;
 }
 import { ParamTypes } from "../params/param-types";

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

@@ -50,126 +50,122 @@
  *
  */
 export class UrlMatcher {
-  static encodeDashes(str: any): string;
-  /** @internal Given a matcher, return an array with the matcher's path segments and path params, in order */
-  static pathSegmentsAndParams(matcher: any): any;
-  /** @internal Given a matcher, return an array with the matcher's query params */
-  static queryParams(matcher: any): any;
-  /**
-   * Compare two UrlMatchers
-   *
-   * This comparison function converts a UrlMatcher into static and dynamic path segments.
-   * Each static path segment is a static string between a path separator (slash character).
-   * Each dynamic segment is a path parameter.
-   *
-   * The comparison function sorts static segments before dynamic ones.
-   */
-  static compare(a: any, b: any): number;
-  /**
-   * @param pattern The pattern to compile into a matcher.
-   * @param paramTypes The [[ParamTypes]] registry
-   * @param paramFactory A [[ParamFactory]] object
-   * @param config  A [[UrlMatcherCompileConfig]] configuration object
-   */
-  constructor(pattern: any, paramTypes: any, paramFactory: any, config: any);
-  _cache: {
-    path: this[];
-  };
-  _children: any[];
-  _params: any[];
-  _segments: any[];
-  _compiled: any[];
-  config: any;
-  pattern: any;
-  /**
-   * Creates a new concatenated UrlMatcher
-   *
-   * Builds a new UrlMatcher by appending another UrlMatcher to this one.
-   *
-   * @param url A `UrlMatcher` instance to append as a child of the current `UrlMatcher`.
-   */
-  append(url: any): any;
-  isRoot(): boolean;
-  /** Returns the input pattern string */
-  toString(): any;
-  _getDecodedParamValue(value: any, param: any): any;
-  /**
-   * Tests the specified url/path against this matcher.
-   *
-   * Tests if the given url matches this matcher's pattern, and returns an object containing the captured
-   * parameter values.  Returns null if the path does not match.
-   *
-   * The returned object contains the values
-   * of any search parameters that are mentioned in the pattern, but their value may be null if
-   * they are not present in `search`. This means that search parameters are always treated
-   * as optional.
-   *
-   * #### Example:
-   * ```js
-   * new UrlMatcher('/user/{id}?q&r').exec('/user/bob', {
-   *   x: '1', q: 'hello'
-   * });
-   * // returns { id: 'bob', q: 'hello', r: null }
-   * ```
-   *
-   * @param path    The URL path to match, e.g. `$location.path()`.
-   * @param search  URL search parameters, e.g. `$location.search()`.
-   * @param hash    URL hash e.g. `$location.hash()`.
-   *
-   * @returns The captured parameter values.
-   */
-  exec(
-    path: any,
-    search: {},
-    hash: any,
-  ): {
-    "#": any;
-  };
-  /**
-   * @internal
-   * Returns all the [[Param]] objects of all path and search parameters of this pattern in order of appearance.
-   *
-   * @returns {Array.<Param>}  An array of [[Param]] objects. Must be treated as read-only. If the
-   *    pattern has no parameters, an empty array is returned.
-   */
-  parameters(opts?: {}): Array<Param>;
-  /**
-   * @internal
-   * Returns a single parameter from this UrlMatcher by id
-   *
-   * @param id
-   * @param opts
-   * @returns {T|Param|any|boolean|UrlMatcher|null}
-   */
-  parameter(id: any, opts?: {}): T | Param | any | boolean | UrlMatcher | null;
-  /**
-   * Validates the input parameter values against this UrlMatcher
-   *
-   * Checks an object hash of parameters to validate their correctness according to the parameter
-   * types of this `UrlMatcher`.
-   *
-   * @param params The object hash of parameters to validate.
-   * @returns Returns `true` if `params` validates, otherwise `false`.
-   */
-  validates(params: any): any;
-  /**
-   * Given a set of parameter values, creates a URL from this UrlMatcher.
-   *
-   * Creates a URL that matches this pattern by substituting the specified values
-   * for the path and search parameters.
-   *
-   * #### Example:
-   * ```js
-   * new UrlMatcher('/user/{id}?q').format({ id:'bob', q:'yes' });
-   * // returns '/user/bob?q=yes'
-   * ```
-   *
-   * @param values  the values to substitute for the parameters in this pattern.
-   * @returns the formatted URL (path and optionally search part).
-   */
-  format(values?: {}): string;
+    static encodeDashes(str: any): string;
+    /** @internal Given a matcher, return an array with the matcher's path segments and path params, in order */
+    static pathSegmentsAndParams(matcher: any): any;
+    /** @internal Given a matcher, return an array with the matcher's query params */
+    static queryParams(matcher: any): any;
+    /**
+     * Compare two UrlMatchers
+     *
+     * This comparison function converts a UrlMatcher into static and dynamic path segments.
+     * Each static path segment is a static string between a path separator (slash character).
+     * Each dynamic segment is a path parameter.
+     *
+     * The comparison function sorts static segments before dynamic ones.
+     */
+    static compare(a: any, b: any): number;
+    /**
+     * @param pattern The pattern to compile into a matcher.
+     * @param paramTypes The [[ParamTypes]] registry
+     * @param paramFactory A [[ParamFactory]] object
+     * @param config  A [[UrlMatcherCompileConfig]] configuration object
+     */
+    constructor(pattern: any, paramTypes: any, paramFactory: any, config: any);
+    _cache: {
+        path: this[];
+    };
+    _children: any[];
+    _params: any[];
+    _segments: any[];
+    _compiled: any[];
+    config: any;
+    pattern: any;
+    /**
+     * Creates a new concatenated UrlMatcher
+     *
+     * Builds a new UrlMatcher by appending another UrlMatcher to this one.
+     *
+     * @param url A `UrlMatcher` instance to append as a child of the current `UrlMatcher`.
+     */
+    append(url: any): any;
+    isRoot(): boolean;
+    /** Returns the input pattern string */
+    toString(): any;
+    _getDecodedParamValue(value: any, param: any): any;
+    /**
+     * Tests the specified url/path against this matcher.
+     *
+     * Tests if the given url matches this matcher's pattern, and returns an object containing the captured
+     * parameter values.  Returns null if the path does not match.
+     *
+     * The returned object contains the values
+     * of any search parameters that are mentioned in the pattern, but their value may be null if
+     * they are not present in `search`. This means that search parameters are always treated
+     * as optional.
+     *
+     * #### Example:
+     * ```js
+     * new UrlMatcher('/user/{id}?q&r').exec('/user/bob', {
+     *   x: '1', q: 'hello'
+     * });
+     * // returns { id: 'bob', q: 'hello', r: null }
+     * ```
+     *
+     * @param path    The URL path to match, e.g. `$location.path()`.
+     * @param search  URL search parameters, e.g. `$location.search()`.
+     * @param hash    URL hash e.g. `$location.hash()`.
+     *
+     * @returns The captured parameter values.
+     */
+    exec(path: any, search: {}, hash: any): {
+        "#": any;
+    };
+    /**
+     * @internal
+     * Returns all the [[Param]] objects of all path and search parameters of this pattern in order of appearance.
+     *
+     * @returns {Array.<Param>}  An array of [[Param]] objects. Must be treated as read-only. If the
+     *    pattern has no parameters, an empty array is returned.
+     */
+    parameters(opts?: {}): Array<Param>;
+    /**
+     * @internal
+     * Returns a single parameter from this UrlMatcher by id
+     *
+     * @param id
+     * @param opts
+     * @returns {T|Param|any|boolean|UrlMatcher|null}
+     */
+    parameter(id: any, opts?: {}): T | Param | any | boolean | UrlMatcher | null;
+    /**
+     * Validates the input parameter values against this UrlMatcher
+     *
+     * Checks an object hash of parameters to validate their correctness according to the parameter
+     * types of this `UrlMatcher`.
+     *
+     * @param params The object hash of parameters to validate.
+     * @returns Returns `true` if `params` validates, otherwise `false`.
+     */
+    validates(params: any): any;
+    /**
+     * Given a set of parameter values, creates a URL from this UrlMatcher.
+     *
+     * Creates a URL that matches this pattern by substituting the specified values
+     * for the path and search parameters.
+     *
+     * #### Example:
+     * ```js
+     * new UrlMatcher('/user/{id}?q').format({ id:'bob', q:'yes' });
+     * // returns '/user/bob?q=yes'
+     * ```
+     *
+     * @param values  the values to substitute for the parameters in this pattern.
+     * @returns the formatted URL (path and optionally search part).
+     */
+    format(values?: {}): string;
 }
 export namespace UrlMatcher {
-  let nameValidator: RegExp;
+    let nameValidator: RegExp;
 }
 import { Param } from "../params/param";