@angular-wave/angular.ts 0.0.20 → 0.0.22

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

@@ -8,54 +8,58 @@
  * @packageDocumentation
  * @preferred
  */
-import { LocationConfig } from '../common';
-import { UIRouter } from '../router';
-import { StateDeclaration, StateObject, TargetState, TargetStateDef } from '../state';
-import { UrlMatcher } from './urlMatcher';
-import { UrlConfig } from './urlConfig';
-import { UrlRules } from './urlRules';
-import { UrlService } from './urlService';
+import { LocationConfig } from "../common";
+import { UIRouter } from "../router";
+import {
+  StateDeclaration,
+  StateObject,
+  TargetState,
+  TargetStateDef,
+} from "../state";
+import { UrlMatcher } from "./urlMatcher";
+import { UrlConfig } from "./urlConfig";
+import { UrlRules } from "./urlRules";
+import { UrlService } from "./urlService";
 export interface UrlMatcherCompileConfig {
-    state?: StateDeclaration;
-    strict?: boolean;
-    caseInsensitive?: boolean;
-    decodeParams?: boolean;
+  state?: StateDeclaration;
+  strict?: boolean;
+  caseInsensitive?: boolean;
+  decodeParams?: boolean;
 }
 /** @deprecated use [[UrlConfig]] */
-export interface UrlConfigApi extends LocationConfig, UrlMatcherConfig {
-}
+export interface UrlConfigApi extends LocationConfig, UrlMatcherConfig {}
 /** @deprecated use [[UrlConfig]] */
 export interface UrlMatcherConfig {
-    /** See: [[UrlConfig.caseInsensitive]] */ caseInsensitive: UrlConfig['caseInsensitive'];
-    /** See: [[UrlConfig.strictMode]] */ strictMode: UrlConfig['strictMode'];
-    /** See: [[UrlConfig.defaultSquashPolicy]] */ defaultSquashPolicy: UrlConfig['defaultSquashPolicy'];
-    /** See: [[UrlConfig.type]] */ type: UrlConfig['type'];
+  /** See: [[UrlConfig.caseInsensitive]] */ caseInsensitive: UrlConfig["caseInsensitive"];
+  /** See: [[UrlConfig.strictMode]] */ strictMode: UrlConfig["strictMode"];
+  /** See: [[UrlConfig.defaultSquashPolicy]] */ defaultSquashPolicy: UrlConfig["defaultSquashPolicy"];
+  /** See: [[UrlConfig.type]] */ type: UrlConfig["type"];
 }
 /** @deprecated use [[UrlService]] */
 export interface UrlSyncApi {
-    /** See: [[UrlService.sync]] */ sync: UrlService['sync'];
-    /** See: [[UrlService.listen]] */ listen: UrlService['listen'];
-    /** See: [[UrlService.deferIntercept]] */ deferIntercept: UrlService['deferIntercept'];
+  /** See: [[UrlService.sync]] */ sync: UrlService["sync"];
+  /** See: [[UrlService.listen]] */ listen: UrlService["listen"];
+  /** See: [[UrlService.deferIntercept]] */ deferIntercept: UrlService["deferIntercept"];
 }
 /** @deprecated use [[UrlRules]] */
 export interface UrlRulesApi {
-    /** See: [[UrlRules.sort]] */ sort: UrlRules['sort'];
-    /** See: [[UrlRules.when]] */ when: UrlRules['when'];
-    /** See: [[UrlRules.otherwise]] */ otherwise: UrlRules['otherwise'];
-    /** See: [[UrlRules.initial]] */ initial: UrlRules['initial'];
-    /** See: [[UrlRules.rules]] */ rules: UrlRules['rules'];
-    /** See: [[UrlRules.rule]] */ rule: UrlRules['rule'];
-    /** See: [[UrlRules.removeRule]] */ removeRule: UrlRules['removeRule'];
+  /** See: [[UrlRules.sort]] */ sort: UrlRules["sort"];
+  /** See: [[UrlRules.when]] */ when: UrlRules["when"];
+  /** See: [[UrlRules.otherwise]] */ otherwise: UrlRules["otherwise"];
+  /** See: [[UrlRules.initial]] */ initial: UrlRules["initial"];
+  /** See: [[UrlRules.rules]] */ rules: UrlRules["rules"];
+  /** See: [[UrlRules.rule]] */ rule: UrlRules["rule"];
+  /** See: [[UrlRules.removeRule]] */ removeRule: UrlRules["removeRule"];
 }
 /**
  * An object containing the three parts of a URL
  */
 export interface UrlParts {
-    path: string;
-    search?: {
-        [key: string]: any;
-    };
-    hash?: string;
+  path: string;
+  search?: {
+    [key: string]: any;
+  };
+  hash?: string;
 }
 /**
  * A UrlRule match result
@@ -63,12 +67,12 @@ export interface UrlParts {
  * The result of UrlRouter.match()
  */
 export interface MatchResult {
-    /** The matched value from a [[UrlRule]] */
-    match: any;
-    /** The rule that matched */
-    rule: UrlRule;
-    /** The match result weight */
-    weight: number;
+  /** The matched value from a [[UrlRule]] */
+  match: any;
+  /** The rule that matched */
+  rule: UrlRule;
+  /** The match result weight */
+  weight: number;
 }
 /**
  * A function that matches the URL for a [[UrlRule]]
@@ -79,7 +83,7 @@ export interface MatchResult {
  * @return the matched value, either truthy or falsey
  */
 export interface UrlRuleMatchFn {
-    (url?: UrlParts, router?: UIRouter): any;
+  (url?: UrlParts, router?: UIRouter): any;
 }
 /**
  * Handler invoked when a rule is matched
@@ -91,66 +95,75 @@ export interface UrlRuleMatchFn {
  * If the handler returns a [[TargetState]], the target state is activated.
  */
 export interface UrlRuleHandlerFn {
-    (matchValue?: any, url?: UrlParts, router?: UIRouter): string | TargetState | TargetStateDef | void;
+  (
+    matchValue?: any,
+    url?: UrlParts,
+    router?: UIRouter,
+  ): string | TargetState | TargetStateDef | void;
 }
 /** @internal */
-export declare type UrlRuleType = 'STATE' | 'URLMATCHER' | 'REGEXP' | 'RAW' | 'OTHER';
+export declare type UrlRuleType =
+  | "STATE"
+  | "URLMATCHER"
+  | "REGEXP"
+  | "RAW"
+  | "OTHER";
 /**
  * The interface for a URL Rule
  *
  * If you are creating a rule for use with [[UrlRules.rule]], it should implement this interface.
  */
 export interface UrlRule {
-    /**
-     * The rule's ID.
-     *
-     * IDs are auto-assigned when the rule is registered, in increasing order.
-     */
-    $id: number;
-    /**
-     * The rule's priority (defaults to 0).
-     *
-     * This can be used to explicitly modify the rule's priority.
-     * Higher numbers are higher priority.
-     */
-    priority: number;
-    /** @internal */
-    _group: number;
-    /** The type of the rule */
-    type: UrlRuleType;
-    /**
-     * This function should match the url and return the match details
-     *
-     * See [[UrlRuleMatchFn]] for details
-     */
-    match: UrlRuleMatchFn;
-    /**
-     * This function is called if the rule matched, and was selected as the "best match".
-     * This function handles the rule match event.
-     *
-     * See [[UrlRuleHandlerFn]] for details
-     */
-    handler: UrlRuleHandlerFn;
-    /**
-     * The priority of a given match.
-     *
-     * Sometimes more than one UrlRule might have matched.
-     * This method is used to choose the best match.
-     *
-     * If multiple rules matched, each rule's `matchPriority` is called with the value from [[match]].
-     * The rule with the highest `matchPriority` has its [[handler]] called.
-     */
-    matchPriority(match: any): number;
+  /**
+   * The rule's ID.
+   *
+   * IDs are auto-assigned when the rule is registered, in increasing order.
+   */
+  $id: number;
+  /**
+   * The rule's priority (defaults to 0).
+   *
+   * This can be used to explicitly modify the rule's priority.
+   * Higher numbers are higher priority.
+   */
+  priority: number;
+  /** @internal */
+  _group: number;
+  /** The type of the rule */
+  type: UrlRuleType;
+  /**
+   * This function should match the url and return the match details
+   *
+   * See [[UrlRuleMatchFn]] for details
+   */
+  match: UrlRuleMatchFn;
+  /**
+   * This function is called if the rule matched, and was selected as the "best match".
+   * This function handles the rule match event.
+   *
+   * See [[UrlRuleHandlerFn]] for details
+   */
+  handler: UrlRuleHandlerFn;
+  /**
+   * The priority of a given match.
+   *
+   * Sometimes more than one UrlRule might have matched.
+   * This method is used to choose the best match.
+   *
+   * If multiple rules matched, each rule's `matchPriority` is called with the value from [[match]].
+   * The rule with the highest `matchPriority` has its [[handler]] called.
+   */
+  matchPriority(match: any): number;
 }
 export interface MatcherUrlRule extends UrlRule {
-    type: 'URLMATCHER' | 'STATE';
-    urlMatcher: UrlMatcher;
+  type: "URLMATCHER" | "STATE";
+  urlMatcher: UrlMatcher;
 }
 export interface StateRule extends MatcherUrlRule {
-    type: 'STATE';
-    state: StateObject;
+  type: "STATE";
+  state: StateObject;
 }
 export interface RegExpRule extends UrlRule {
-    type: 'REGEXP';
-    regexp: RegExp;
+  type: "REGEXP";
+  regexp: RegExp;
 }

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

@@ -1,6 +1,6 @@
-import { Disposable } from '../interface';
-import { UIRouter } from '../router';
-import { ParamTypeDefinition, ParamTypes } from '../params';
+import { Disposable } from "../interface";
+import { UIRouter } from "../router";
+import { ParamTypeDefinition, ParamTypes } from "../params";
 /**
  * An API to customize the URL behavior and retrieve URL configuration
  *
@@ -15,127 +15,131 @@ import { ParamTypeDefinition, ParamTypes } from '../params';
  * This API is found at `router.urlService.config` (see: [[UIRouter.urlService]], [[URLService.config]])
  */
 export declare class UrlConfig implements Disposable {
-    private router;
-    /** @internal */ paramTypes: ParamTypes;
-    /** @internal */ _decodeParams: boolean;
-    /** @internal */ _isCaseInsensitive: boolean;
-    /** @internal */ _isStrictMode: boolean;
-    /** @internal */ _defaultSquashPolicy: boolean | string;
-    /** @internal */ constructor(/** @internal */ router: UIRouter);
-    /** @internal */ dispose: () => void;
-    /**
-     * Gets the base Href, e.g., `http://localhost/approot/`
-     *
-     * @return the application's base href
-     */
-    baseHref: () => string;
-    /**
-     * Gets or sets the hashPrefix
-     *
-     * This only applies when not running in [[html5Mode]] (pushstate mode)
-     *
-     * If the current url is `http://localhost/app#!/uirouter/path/#anchor`, it returns `!` which is the prefix for the "hashbang" portion.
-     *
-     * @return the hash prefix
-     */
-    hashPrefix: (newprefix?: string) => string;
-    /**
-     * Gets the host, e.g., `localhost`
-     *
-     * @return the protocol
-     */
-    host: () => string;
-    /**
-     * Returns true when running in pushstate mode
-     *
-     * @return true when running in html5 mode (pushstate mode).
-     */
-    html5Mode: () => boolean;
-    /**
-     * Gets the port, e.g., `80`
-     *
-     * @return the port number
-     */
-    port: () => number;
-    /**
-     * Gets the protocol, e.g., `http`
-     *
-     * @return the protocol
-     */
-    protocol: () => string;
-    /**
-     * 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?: boolean): boolean;
-    /**
-     * 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?: boolean | string): string | boolean;
-    /**
-     * 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?: boolean): boolean;
-    /**
-     * 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: string, definition?: ParamTypeDefinition, definitionFn?: () => ParamTypeDefinition): any;
+  private router;
+  /** @internal */ paramTypes: ParamTypes;
+  /** @internal */ _decodeParams: boolean;
+  /** @internal */ _isCaseInsensitive: boolean;
+  /** @internal */ _isStrictMode: boolean;
+  /** @internal */ _defaultSquashPolicy: boolean | string;
+  /** @internal */ constructor(/** @internal */ router: UIRouter);
+  /** @internal */ dispose: () => void;
+  /**
+   * Gets the base Href, e.g., `http://localhost/approot/`
+   *
+   * @return the application's base href
+   */
+  baseHref: () => string;
+  /**
+   * Gets or sets the hashPrefix
+   *
+   * This only applies when not running in [[html5Mode]] (pushstate mode)
+   *
+   * If the current url is `http://localhost/app#!/uirouter/path/#anchor`, it returns `!` which is the prefix for the "hashbang" portion.
+   *
+   * @return the hash prefix
+   */
+  hashPrefix: (newprefix?: string) => string;
+  /**
+   * Gets the host, e.g., `localhost`
+   *
+   * @return the protocol
+   */
+  host: () => string;
+  /**
+   * Returns true when running in pushstate mode
+   *
+   * @return true when running in html5 mode (pushstate mode).
+   */
+  html5Mode: () => boolean;
+  /**
+   * Gets the port, e.g., `80`
+   *
+   * @return the port number
+   */
+  port: () => number;
+  /**
+   * Gets the protocol, e.g., `http`
+   *
+   * @return the protocol
+   */
+  protocol: () => string;
+  /**
+   * 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?: boolean): boolean;
+  /**
+   * 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?: boolean | string): string | boolean;
+  /**
+   * 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?: boolean): boolean;
+  /**
+   * 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: string,
+    definition?: ParamTypeDefinition,
+    definitionFn?: () => ParamTypeDefinition,
+  ): any;
 }