@angular-wave/angular.ts 0.0.20 → 0.0.22

package/types/router/core/url/urlMatcher.d.ts

@@ -1,8 +1,8 @@
-import { Param } from '../params/param';
-import { ParamTypes } from '../params/paramTypes';
-import { RawParams } from '../params/interface';
-import { UrlMatcherCompileConfig } from './interface';
-import { ParamFactory } from './urlMatcherFactory';
+import { Param } from "../params/param";
+import { ParamTypes } from "../params/paramTypes";
+import { RawParams } from "../params/interface";
+import { UrlMatcherCompileConfig } from "./interface";
+import { ParamFactory } from "./urlMatcherFactory";
 /**
  * Matches URLs against patterns.
  *
@@ -55,126 +55,131 @@ import { ParamFactory } from './urlMatcherFactory';
  *
  */
 export declare class UrlMatcher {
-    /** @internal */
-    static nameValidator: RegExp;
-    /** @internal */
-    private _cache;
-    /** @internal */
-    private _children;
-    /** @internal */
-    private _params;
-    /** @internal */
-    private _segments;
-    /** @internal */
-    private _compiled;
-    /** @internal */
-    private readonly config;
-    /** The pattern that was passed into the constructor */
-    pattern: string;
-    /** @internal */
-    static encodeDashes(str: string): string;
-    /** @internal Given a matcher, return an array with the matcher's path segments and path params, in order */
-    static pathSegmentsAndParams(matcher: UrlMatcher): any;
-    /** @internal Given a matcher, return an array with the matcher's query params */
-    static queryParams(matcher: UrlMatcher): Param[];
-    /**
-     * 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: UrlMatcher, b: UrlMatcher): 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: string, paramTypes: ParamTypes, paramFactory: ParamFactory, config?: UrlMatcherCompileConfig);
-    /**
-     * 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: UrlMatcher): UrlMatcher;
-    /** @internal */
-    isRoot(): boolean;
-    /** Returns the input pattern string */
-    toString(): string;
-    private _getDecodedParamValue;
-    /**
-     * 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()`.
-     * @param options
-     *
-     * @returns The captured parameter values.
-     */
-    exec(path: string, search?: any, hash?: string, options?: any): RawParams;
-    /**
-     * @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?: any): Param[];
-    /**
-     * @internal
-     * Returns a single parameter from this UrlMatcher by id
-     *
-     * @param id
-     * @param opts
-     * @returns {T|Param|any|boolean|UrlMatcher|null}
-     */
-    parameter(id: string, opts?: any): Param;
-    /**
-     * 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: RawParams): boolean;
-    /**
-     * 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?: RawParams): string;
+  /** @internal */
+  static nameValidator: RegExp;
+  /** @internal */
+  private _cache;
+  /** @internal */
+  private _children;
+  /** @internal */
+  private _params;
+  /** @internal */
+  private _segments;
+  /** @internal */
+  private _compiled;
+  /** @internal */
+  private readonly config;
+  /** The pattern that was passed into the constructor */
+  pattern: string;
+  /** @internal */
+  static encodeDashes(str: string): string;
+  /** @internal Given a matcher, return an array with the matcher's path segments and path params, in order */
+  static pathSegmentsAndParams(matcher: UrlMatcher): any;
+  /** @internal Given a matcher, return an array with the matcher's query params */
+  static queryParams(matcher: UrlMatcher): Param[];
+  /**
+   * 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: UrlMatcher, b: UrlMatcher): 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: string,
+    paramTypes: ParamTypes,
+    paramFactory: ParamFactory,
+    config?: UrlMatcherCompileConfig,
+  );
+  /**
+   * 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: UrlMatcher): UrlMatcher;
+  /** @internal */
+  isRoot(): boolean;
+  /** Returns the input pattern string */
+  toString(): string;
+  private _getDecodedParamValue;
+  /**
+   * 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()`.
+   * @param options
+   *
+   * @returns The captured parameter values.
+   */
+  exec(path: string, search?: any, hash?: string, options?: any): RawParams;
+  /**
+   * @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?: any): Param[];
+  /**
+   * @internal
+   * Returns a single parameter from this UrlMatcher by id
+   *
+   * @param id
+   * @param opts
+   * @returns {T|Param|any|boolean|UrlMatcher|null}
+   */
+  parameter(id: string, opts?: any): Param;
+  /**
+   * 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: RawParams): boolean;
+  /**
+   * 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?: RawParams): string;
 }

package/types/router/core/url/urlMatcherFactory.d.ts

@@ -1,14 +1,14 @@
-import { UrlMatcher } from './urlMatcher';
-import { Param, ParamType, ParamTypeDefinition } from '../params';
-import { UrlMatcherCompileConfig } from './interface';
-import { StateDeclaration } from '../state';
-import { UIRouter } from '../router';
+import { UrlMatcher } from "./urlMatcher";
+import { Param, ParamType, ParamTypeDefinition } from "../params";
+import { UrlMatcherCompileConfig } from "./interface";
+import { StateDeclaration } from "../state";
+import { UIRouter } from "../router";
 export declare class ParamFactory {
-    private router;
-    fromConfig(id: string, type: ParamType, state: StateDeclaration): Param;
-    fromPath(id: string, type: ParamType, state: StateDeclaration): Param;
-    fromSearch(id: string, type: ParamType, state: StateDeclaration): Param;
-    constructor(router: UIRouter);
+  private router;
+  fromConfig(id: string, type: ParamType, state: StateDeclaration): Param;
+  fromPath(id: string, type: ParamType, state: StateDeclaration): Param;
+  fromSearch(id: string, type: ParamType, state: StateDeclaration): Param;
+  constructor(router: UIRouter);
 }
 /**
  * Factory for [[UrlMatcher]] instances.
@@ -17,36 +17,40 @@ export declare class ParamFactory {
  * `$urlMatcherFactory` or ng1 providers as `$urlMatcherFactoryProvider`.
  */
 export declare class UrlMatcherFactory {
-    private router;
-    /** Creates a new [[Param]] for a given location (DefType) */
-    paramFactory: ParamFactory;
-    UrlMatcher: typeof UrlMatcher;
-    Param: typeof Param;
-    constructor(/** @internal */ router: UIRouter);
-    /**
-     * Creates a [[UrlMatcher]] for the specified pattern.
-     *
-     * @param pattern  The URL pattern.
-     * @param config  The config object hash.
-     * @returns The UrlMatcher.
-     */
-    compile(pattern: string, config?: UrlMatcherCompileConfig): 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;
-    /** @internal */
-    $get(): this;
-    /** @deprecated use [[UrlConfig.caseInsensitive]] */
-    caseInsensitive: (value?: boolean) => boolean;
-    /** @deprecated use [[UrlConfig.defaultSquashPolicy]] */
-    defaultSquashPolicy: (value?: boolean | string) => string | boolean;
-    /** @deprecated use [[UrlConfig.strictMode]] */
-    strictMode: (value?: boolean) => boolean;
-    /** @deprecated use [[UrlConfig.type]] */
-    type: (name: string, definition?: ParamTypeDefinition, definitionFn?: () => ParamTypeDefinition) => any;
+  private router;
+  /** Creates a new [[Param]] for a given location (DefType) */
+  paramFactory: ParamFactory;
+  UrlMatcher: typeof UrlMatcher;
+  Param: typeof Param;
+  constructor(/** @internal */ router: UIRouter);
+  /**
+   * Creates a [[UrlMatcher]] for the specified pattern.
+   *
+   * @param pattern  The URL pattern.
+   * @param config  The config object hash.
+   * @returns The UrlMatcher.
+   */
+  compile(pattern: string, config?: UrlMatcherCompileConfig): 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;
+  /** @internal */
+  $get(): this;
+  /** @deprecated use [[UrlConfig.caseInsensitive]] */
+  caseInsensitive: (value?: boolean) => boolean;
+  /** @deprecated use [[UrlConfig.defaultSquashPolicy]] */
+  defaultSquashPolicy: (value?: boolean | string) => string | boolean;
+  /** @deprecated use [[UrlConfig.strictMode]] */
+  strictMode: (value?: boolean) => boolean;
+  /** @deprecated use [[UrlConfig.type]] */
+  type: (
+    name: string,
+    definition?: ParamTypeDefinition,
+    definitionFn?: () => ParamTypeDefinition,
+  ) => any;
 }

package/types/router/core/url/urlRouter.d.ts

@@ -1,9 +1,9 @@
-import { UrlMatcher } from './urlMatcher';
-import { RawParams } from '../params';
-import { UIRouter } from '../router';
-import { UrlRuleFactory } from './urlRule';
-import { MatchResult, UrlParts, UrlRule, UrlRuleHandlerFn } from './interface';
-import { TargetState, TargetStateDef } from '../state';
+import { UrlMatcher } from "./urlMatcher";
+import { RawParams } from "../params";
+import { UIRouter } from "../router";
+import { UrlRuleFactory } from "./urlRule";
+import { MatchResult, UrlParts, UrlRule, UrlRuleHandlerFn } from "./interface";
+import { TargetState, TargetStateDef } from "../state";
 /**
  * Updates URL and responds to URL changes
  *
@@ -13,73 +13,89 @@ import { TargetState, TargetStateDef } from '../state';
  * For configuring URL rules, use the [[UrlRules]] which can be found as [[UrlService.rules]].
  */
 export declare class UrlRouter {
-    private router;
-    /** used to create [[UrlRule]] objects for common cases */
-    urlRuleFactory: UrlRuleFactory;
-    /** @internal */ private location;
-    /** @internal */
-    constructor(/** @internal */ router: UIRouter);
-    /** Internal API. */
-    update(read?: boolean): void;
-    /**
-     * Internal API.
-     *
-     * Pushes a new location to the browser history.
-     *
-     * @internal
-     * @param urlMatcher
-     * @param params
-     * @param options
-     */
-    push(urlMatcher: UrlMatcher, params?: RawParams, options?: {
-        replace?: string | boolean;
-    }): void;
-    /**
-     * Builds and returns a URL with interpolated parameters
-     *
-     * #### Example:
-     * ```js
-     * matcher = $umf.compile("/about/:person");
-     * params = { person: "bob" };
-     * $bob = $urlRouter.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: UrlMatcher, params?: any, options?: {
-        absolute: boolean;
-    }): string;
-    /** @deprecated use [[UrlService.sync]]*/
-    sync: (evt?: any) => void;
-    /** @deprecated use [[UrlService.listen]]*/
-    listen: (enabled?: boolean) => Function;
-    /** @deprecated use [[UrlService.deferIntercept]]*/
-    deferIntercept: (defer?: boolean) => void;
-    /** @deprecated use [[UrlService.interceptDeferred]]*/
-    interceptDeferred: boolean;
-    /** @deprecated use [[UrlService.match]]*/
-    match: (urlParts: UrlParts) => MatchResult;
-    /** @deprecated use [[UrlRules.initial]]*/
-    initial: (handler: string | UrlRuleHandlerFn | TargetState | TargetStateDef) => void;
-    /** @deprecated use [[UrlRules.otherwise]]*/
-    otherwise: (handler: string | UrlRuleHandlerFn | TargetState | TargetStateDef) => void;
-    /** @deprecated use [[UrlRules.removeRule]]*/
-    removeRule: (rule: UrlRule) => void;
-    /** @deprecated use [[UrlRules.rule]]*/
-    rule: (rule: UrlRule) => Function;
-    /** @deprecated use [[UrlRules.rules]]*/
-    rules: () => UrlRule[];
-    /** @deprecated use [[UrlRules.sort]]*/
-    sort: (compareFn?: (a: UrlRule, b: UrlRule) => number) => void;
-    /** @deprecated use [[UrlRules.when]]*/
-    when: (matcher: RegExp | UrlMatcher | string, handler: string | UrlRuleHandlerFn, options?: {
-        priority: number;
-    }) => UrlRule;
+  private router;
+  /** used to create [[UrlRule]] objects for common cases */
+  urlRuleFactory: UrlRuleFactory;
+  /** @internal */ private location;
+  /** @internal */
+  constructor(/** @internal */ router: UIRouter);
+  /** Internal API. */
+  update(read?: boolean): void;
+  /**
+   * Internal API.
+   *
+   * Pushes a new location to the browser history.
+   *
+   * @internal
+   * @param urlMatcher
+   * @param params
+   * @param options
+   */
+  push(
+    urlMatcher: UrlMatcher,
+    params?: RawParams,
+    options?: {
+      replace?: string | boolean;
+    },
+  ): void;
+  /**
+   * Builds and returns a URL with interpolated parameters
+   *
+   * #### Example:
+   * ```js
+   * matcher = $umf.compile("/about/:person");
+   * params = { person: "bob" };
+   * $bob = $urlRouter.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: UrlMatcher,
+    params?: any,
+    options?: {
+      absolute: boolean;
+    },
+  ): string;
+  /** @deprecated use [[UrlService.sync]]*/
+  sync: (evt?: any) => void;
+  /** @deprecated use [[UrlService.listen]]*/
+  listen: (enabled?: boolean) => Function;
+  /** @deprecated use [[UrlService.deferIntercept]]*/
+  deferIntercept: (defer?: boolean) => void;
+  /** @deprecated use [[UrlService.interceptDeferred]]*/
+  interceptDeferred: boolean;
+  /** @deprecated use [[UrlService.match]]*/
+  match: (urlParts: UrlParts) => MatchResult;
+  /** @deprecated use [[UrlRules.initial]]*/
+  initial: (
+    handler: string | UrlRuleHandlerFn | TargetState | TargetStateDef,
+  ) => void;
+  /** @deprecated use [[UrlRules.otherwise]]*/
+  otherwise: (
+    handler: string | UrlRuleHandlerFn | TargetState | TargetStateDef,
+  ) => void;
+  /** @deprecated use [[UrlRules.removeRule]]*/
+  removeRule: (rule: UrlRule) => void;
+  /** @deprecated use [[UrlRules.rule]]*/
+  rule: (rule: UrlRule) => Function;
+  /** @deprecated use [[UrlRules.rules]]*/
+  rules: () => UrlRule[];
+  /** @deprecated use [[UrlRules.sort]]*/
+  sort: (compareFn?: (a: UrlRule, b: UrlRule) => number) => void;
+  /** @deprecated use [[UrlRules.when]]*/
+  when: (
+    matcher: RegExp | UrlMatcher | string,
+    handler: string | UrlRuleHandlerFn,
+    options?: {
+      priority: number;
+    },
+  ) => UrlRule;
 }