@angular-wave/angular.ts 0.0.38 → 0.0.40

package/types/router/state/target-state.d.ts

@@ -28,75 +28,70 @@
  * or invalid (the state being targeted is not registered).
  */
 export class TargetState {
-  /**
-   * The TargetState constructor
-   *
-   * Note: Do not construct a `TargetState` manually.
-   * To create a `TargetState`, use the [[StateService.target]] factory method.
-   *
-   * @param _stateRegistry The StateRegistry to use to look up the _definition
-   * @param _identifier An identifier for a state.
-   *    Either a fully-qualified state name, or the object used to define the state.
-   * @param _params Parameters for the target state
-   * @param _options Transition options.
-   *
-   * @internal
-   */
-  constructor(
-    _stateRegistry: any,
-    _identifier: any,
-    _params: any,
-    _options: any,
-  );
-  _stateRegistry: any;
-  _identifier: any;
-  _params: any;
-  _options: any;
-  _definition: any;
-  /** The name of the state this object targets */
-  name(): any;
-  /** The identifier used when creating this TargetState */
-  identifier(): any;
-  /** The target parameter values */
-  params(): any;
-  /** The internal state object (if it was found) */
-  $state(): any;
-  /** The internal state declaration (if it was found) */
-  state(): any;
-  /** The target options */
-  options(): any;
-  /** True if the target state was found */
-  exists(): boolean;
-  /** True if the object is valid */
-  valid(): boolean;
-  /** If the object is invalid, returns the reason why */
-  error(): string;
-  toString(): string;
-  /**
-   * Returns a copy of this TargetState which targets a different state.
-   * The new TargetState has the same parameter values and transition options.
-   *
-   * @param state The new state that should be targeted
-   */
-  withState(state: any): TargetState;
-  /**
-   * Returns a copy of this TargetState, using the specified parameter values.
-   *
-   * @param params the new parameter values to use
-   * @param replace When false (default) the new parameter values will be merged with the current values.
-   *                When true the parameter values will be used instead of the current values.
-   */
-  withParams(params: any, replace?: boolean): TargetState;
-  /**
-   * Returns a copy of this TargetState, using the specified Transition Options.
-   *
-   * @param options the new options to use
-   * @param replace When false (default) the new options will be merged with the current options.
-   *                When true the options will be used instead of the current options.
-   */
-  withOptions(options: any, replace?: boolean): TargetState;
+    /**
+     * The TargetState constructor
+     *
+     * Note: Do not construct a `TargetState` manually.
+     * To create a `TargetState`, use the [[StateService.target]] factory method.
+     *
+     * @param _stateRegistry The StateRegistry to use to look up the _definition
+     * @param _identifier An identifier for a state.
+     *    Either a fully-qualified state name, or the object used to define the state.
+     * @param _params Parameters for the target state
+     * @param _options Transition options.
+     *
+     * @internal
+     */
+    constructor(_stateRegistry: any, _identifier: any, _params: any, _options: any);
+    _stateRegistry: any;
+    _identifier: any;
+    _params: any;
+    _options: any;
+    _definition: any;
+    /** The name of the state this object targets */
+    name(): any;
+    /** The identifier used when creating this TargetState */
+    identifier(): any;
+    /** The target parameter values */
+    params(): any;
+    /** The internal state object (if it was found) */
+    $state(): any;
+    /** The internal state declaration (if it was found) */
+    state(): any;
+    /** The target options */
+    options(): any;
+    /** True if the target state was found */
+    exists(): boolean;
+    /** True if the object is valid */
+    valid(): boolean;
+    /** If the object is invalid, returns the reason why */
+    error(): string;
+    toString(): string;
+    /**
+     * Returns a copy of this TargetState which targets a different state.
+     * The new TargetState has the same parameter values and transition options.
+     *
+     * @param state The new state that should be targeted
+     */
+    withState(state: any): TargetState;
+    /**
+     * Returns a copy of this TargetState, using the specified parameter values.
+     *
+     * @param params the new parameter values to use
+     * @param replace When false (default) the new parameter values will be merged with the current values.
+     *                When true the parameter values will be used instead of the current values.
+     */
+    withParams(params: any, replace?: boolean): TargetState;
+    /**
+     * Returns a copy of this TargetState, using the specified Transition Options.
+     *
+     * @param options the new options to use
+     * @param replace When false (default) the new options will be merged with the current options.
+     *                When true the options will be used instead of the current options.
+     */
+    withOptions(options: any, replace?: boolean): TargetState;
 }
 export namespace TargetState {
-  /** Returns true if the object has a state property that might be a state or state name */
-  function isDef(obj: any): boolean;
+    /** Returns true if the object has a state property that might be a state or state name */
+    function isDef(obj: any): boolean;
 }

package/types/router/state/views.d.ts

@@ -1,7 +1,4 @@
-export function getNg1ViewConfigFactory(): (
-  path: any,
-  view: any,
-) => Ng1ViewConfig[];
+export function getNg1ViewConfigFactory(): (path: any, view: any) => Ng1ViewConfig[];
 /**
  * This is a [[StateBuilder.builder]] function for angular1 `views`.
  *
@@ -14,37 +11,34 @@ export function getNg1ViewConfigFactory(): (
  */
 export function ng1ViewsBuilder(state: any): {};
 export class Ng1ViewConfig {
-  /**
-   * Normalizes a view's name from a state.views configuration block.
-   *
-   * This should be used by a framework implementation to calculate the values for
-   * [[_ViewDeclaration.$ngViewName]] and [[_ViewDeclaration.$ngViewContextAnchor]].
-   *
-   * @param context the context object (state declaration) that the view belongs to
-   * @param rawViewName the name of the view, as declared in the [[StateDeclaration.views]]
-   *
-   * @returns the normalized ngViewName and ngViewContextAnchor that the view targets
-   */
-  static normalizeUIViewTarget(
-    context: any,
-    rawViewName?: string,
-  ): {
-    ngViewName: string;
-    ngViewContextAnchor: string;
-  };
-  constructor(path: any, viewDecl: any, factory: any);
-  path: any;
-  viewDecl: any;
-  factory: any;
-  /** @type {Number} */ $id: number;
-  loaded: boolean;
-  getTemplate: (ngView: any, context: any) => any;
-  load(): any;
-  controller: any;
-  /**
-   * Gets the controller for a view configuration.
-   *
-   * @returns {Function|Promise.<Function>} Returns a controller, or a promise that resolves to a controller.
-   */
-  getController(context: any): Function | Promise<Function>;
+    /**
+     * Normalizes a view's name from a state.views configuration block.
+     *
+     * This should be used by a framework implementation to calculate the values for
+     * [[_ViewDeclaration.$ngViewName]] and [[_ViewDeclaration.$ngViewContextAnchor]].
+     *
+     * @param context the context object (state declaration) that the view belongs to
+     * @param rawViewName the name of the view, as declared in the [[StateDeclaration.views]]
+     *
+     * @returns the normalized ngViewName and ngViewContextAnchor that the view targets
+     */
+    static normalizeUIViewTarget(context: any, rawViewName?: string): {
+        ngViewName: string;
+        ngViewContextAnchor: string;
+    };
+    constructor(path: any, viewDecl: any, factory: any);
+    path: any;
+    viewDecl: any;
+    factory: any;
+    /** @type {Number} */ $id: number;
+    loaded: boolean;
+    getTemplate: (ngView: any, context: any) => any;
+    load(): any;
+    controller: any;
+    /**
+     * Gets the controller for a view configuration.
+     *
+     * @returns {Function|Promise.<Function>} Returns a controller, or a promise that resolves to a controller.
+     */
+    getController(context: any): Function | Promise<Function>;
 }

package/types/router/state-filters.d.ts

@@ -1,15 +1,15 @@
 export function $IsStateFilter($state: any): {
-  (state: any, params: any, options: any): any;
-  $stateful: boolean;
+    (state: any, params: any, options: any): any;
+    $stateful: boolean;
 };
 export namespace $IsStateFilter {
-  let $inject: string[];
+    let $inject: string[];
 }
 export function $IncludedByStateFilter($state: any): {
-  (state: any, params: any, options: any): any;
-  $stateful: boolean;
+    (state: any, params: any, options: any): any;
+    $stateful: boolean;
 };
 export namespace $IncludedByStateFilter {
-  let $inject_1: string[];
-  export { $inject_1 as $inject };
+    let $inject_1: string[];
+    export { $inject_1 as $inject };
 }

package/types/router/state-provider.d.ts

@@ -15,109 +15,109 @@
  * The `$stateProvider` provides interfaces to declare these states for your app.
  */
 export class StateProvider {
-  constructor(stateRegistry: any, stateService: any);
-  stateRegistry: any;
-  stateService: any;
-  /**
-   * Decorates states when they are registered
-   *
-   * Allows you to extend (carefully) or override (at your own peril) the
-   * `stateBuilder` object used internally by [[StateRegistry]].
-   * This can be used to add custom functionality to ui-router,
-   * for example inferring templateUrl based on the state name.
-   *
-   * When passing only a name, it returns the current (original or decorated) builder
-   * function that matches `name`.
-   *
-   * The builder functions that can be decorated are listed below. Though not all
-   * necessarily have a good use case for decoration, that is up to you to decide.
-   *
-   * In addition, users can attach custom decorators, which will generate new
-   * properties within the state's internal definition. There is currently no clear
-   * use-case for this beyond accessing internal states (i.e. $state.$current),
-   * however, expect this to become increasingly relevant as we introduce additional
-   * meta-programming features.
-   *
-   * **Warning**: Decorators should not be interdependent because the order of
-   * execution of the builder functions in non-deterministic. Builder functions
-   * should only be dependent on the state definition object and super function.
-   *
-   *
-   * Existing builder functions and current return values:
-   *
-   * - **parent** `{object}` - returns the parent state object.
-   * - **data** `{object}` - returns state data, including any inherited data that is not
-   *   overridden by own values (if any).
-   * - **url** `{object}` - returns a {@link ui.router.util.type:UrlMatcher UrlMatcher}
-   *   or `null`.
-   * - **navigable** `{object}` - returns closest ancestor state that has a URL (aka is
-   *   navigable).
-   * - **params** `{object}` - returns an array of state params that are ensured to
-   *   be a super-set of parent's params.
-   * - **views** `{object}` - returns a views object where each key is an absolute view
-   *   name (i.e. "viewName@stateName") and each value is the config object
-   *   (template, controller) for the view. Even when you don't use the views object
-   *   explicitly on a state config, one is still created for you internally.
-   *   So by decorating this builder function you have access to decorating template
-   *   and controller properties.
-   * - **ownParams** `{object}` - returns an array of params that belong to the state,
-   *   not including any params defined by ancestor states.
-   * - **path** `{string}` - returns the full path from the root down to this state.
-   *   Needed for state activation.
-   * - **includes** `{object}` - returns an object that includes every state that
-   *   would pass a `$state.includes()` test.
-   *
-   * #### Example:
-   * Override the internal 'views' builder with a function that takes the state
-   * definition, and a reference to the internal function being overridden:
-   * ```js
-   * $stateProvider.decorator('views', function (state, parent) {
-   *   let result = {},
-   *       views = parent(state);
-   *
-   *   angular.forEach(views, function (config, name) {
-   *     let autoName = (state.name + '.' + name).replace('.', '/');
-   *     config.templateUrl = config.templateUrl || '/partials/' + autoName + '.html';
-   *     result[name] = config;
-   *   });
-   *   return result;
-   * });
-   *
-   * $stateProvider.state('home', {
-   *   views: {
-   *     'contact.list': { controller: 'ListController' },
-   *     'contact.item': { controller: 'ItemController' }
-   *   }
-   * });
-   * ```
-   *
-   *
-   * ```js
-   * // Auto-populates list and item views with /partials/home/contact/list.html,
-   * // and /partials/home/contact/item.html, respectively.
-   * $state.go('home');
-   * ```
-   *
-   * @param {string} name The name of the builder function to decorate.
-   * @param {object} func A function that is responsible for decorating the original
-   * builder function. The function receives two parameters:
-   *
-   *   - `{object}` - state - The state config object.
-   *   - `{object}` - super - The original builder function.
-   *
-   * @return {object} $stateProvider - $stateProvider instance
-   */
-  decorator(name: string, func: object): object;
-  /**
-   *
-   * @param {angular.Ng1StateDeclaration} definition
-   * @returns {StateProvider}
-   */
-  state(definition: angular.Ng1StateDeclaration): StateProvider;
-  /**
-   * Registers an invalid state handler
-   *
-   * This is a passthrough to [[StateService.onInvalid]] for ng1.
-   */
-  onInvalid(callback: any): any;
+    constructor(stateRegistry: any, stateService: any);
+    stateRegistry: any;
+    stateService: any;
+    /**
+     * Decorates states when they are registered
+     *
+     * Allows you to extend (carefully) or override (at your own peril) the
+     * `stateBuilder` object used internally by [[StateRegistry]].
+     * This can be used to add custom functionality to ui-router,
+     * for example inferring templateUrl based on the state name.
+     *
+     * When passing only a name, it returns the current (original or decorated) builder
+     * function that matches `name`.
+     *
+     * The builder functions that can be decorated are listed below. Though not all
+     * necessarily have a good use case for decoration, that is up to you to decide.
+     *
+     * In addition, users can attach custom decorators, which will generate new
+     * properties within the state's internal definition. There is currently no clear
+     * use-case for this beyond accessing internal states (i.e. $state.$current),
+     * however, expect this to become increasingly relevant as we introduce additional
+     * meta-programming features.
+     *
+     * **Warning**: Decorators should not be interdependent because the order of
+     * execution of the builder functions in non-deterministic. Builder functions
+     * should only be dependent on the state definition object and super function.
+     *
+     *
+     * Existing builder functions and current return values:
+     *
+     * - **parent** `{object}` - returns the parent state object.
+     * - **data** `{object}` - returns state data, including any inherited data that is not
+     *   overridden by own values (if any).
+     * - **url** `{object}` - returns a {@link ui.router.util.type:UrlMatcher UrlMatcher}
+     *   or `null`.
+     * - **navigable** `{object}` - returns closest ancestor state that has a URL (aka is
+     *   navigable).
+     * - **params** `{object}` - returns an array of state params that are ensured to
+     *   be a super-set of parent's params.
+     * - **views** `{object}` - returns a views object where each key is an absolute view
+     *   name (i.e. "viewName@stateName") and each value is the config object
+     *   (template, controller) for the view. Even when you don't use the views object
+     *   explicitly on a state config, one is still created for you internally.
+     *   So by decorating this builder function you have access to decorating template
+     *   and controller properties.
+     * - **ownParams** `{object}` - returns an array of params that belong to the state,
+     *   not including any params defined by ancestor states.
+     * - **path** `{string}` - returns the full path from the root down to this state.
+     *   Needed for state activation.
+     * - **includes** `{object}` - returns an object that includes every state that
+     *   would pass a `$state.includes()` test.
+     *
+     * #### Example:
+     * Override the internal 'views' builder with a function that takes the state
+     * definition, and a reference to the internal function being overridden:
+     * ```js
+     * $stateProvider.decorator('views', function (state, parent) {
+     *   let result = {},
+     *       views = parent(state);
+     *
+     *   angular.forEach(views, function (config, name) {
+     *     let autoName = (state.name + '.' + name).replace('.', '/');
+     *     config.templateUrl = config.templateUrl || '/partials/' + autoName + '.html';
+     *     result[name] = config;
+     *   });
+     *   return result;
+     * });
+     *
+     * $stateProvider.state('home', {
+     *   views: {
+     *     'contact.list': { controller: 'ListController' },
+     *     'contact.item': { controller: 'ItemController' }
+     *   }
+     * });
+     * ```
+     *
+     *
+     * ```js
+     * // Auto-populates list and item views with /partials/home/contact/list.html,
+     * // and /partials/home/contact/item.html, respectively.
+     * $state.go('home');
+     * ```
+     *
+     * @param {string} name The name of the builder function to decorate.
+     * @param {object} func A function that is responsible for decorating the original
+     * builder function. The function receives two parameters:
+     *
+     *   - `{object}` - state - The state config object.
+     *   - `{object}` - super - The original builder function.
+     *
+     * @return {object} $stateProvider - $stateProvider instance
+     */
+    decorator(name: string, func: object): object;
+    /**
+     *
+     * @param {angular.Ng1StateDeclaration} definition
+     * @returns {StateProvider}
+     */
+    state(definition: angular.Ng1StateDeclaration): StateProvider;
+    /**
+     * Registers an invalid state handler
+     *
+     * This is a passthrough to [[StateService.onInvalid]] for ng1.
+     */
+    onInvalid(callback: any): any;
 }