angular-route.d.ts

// Type definitions for Angular JS 1.3 (ngRoute module)
// Project: http://angularjs.org
// Definitions by: Jonathan Park <https://github.com/park9140>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

/// <reference path="angular.d.ts" />

declare module "angular-route" {
    var _: string;
    export = _;
}

///////////////////////////////////////////////////////////////////////////////
// ngRoute module (angular-route.js)
///////////////////////////////////////////////////////////////////////////////
declare module angular.route {

    ///////////////////////////////////////////////////////////////////////////
    // RouteParamsService
    // see http://docs.angularjs.org/api/ngRoute.$routeParams
    ///////////////////////////////////////////////////////////////////////////
    interface IRouteParamsService {
        [key: string]: any;
    }

    ///////////////////////////////////////////////////////////////////////////
    // RouteService
    // see http://docs.angularjs.org/api/ngRoute.$route
    // see http://docs.angularjs.org/api/ngRoute.$routeProvider
    ///////////////////////////////////////////////////////////////////////////
    interface IRouteService {
        reload(): void;
        routes: any;

        // May not always be available. For instance, current will not be available
        // to a controller that was not initialized as a result of a route maching.
        current?: ICurrentRoute;
    }


    /**
     * see http://docs.angularjs.org/api/ngRoute/provider/$routeProvider#when for API documentation
     */
    interface IRoute {
        /**
         * {(string|function()=}
         * Controller fn that should be associated with newly created scope or the name of a registered controller if passed as a string.
         */
        controller?: string|Function;
        /**
         * A controller alias name. If present the controller will be published to scope under the controllerAs name.
         */
        controllerAs?: string;
        /**
         * Undocumented?
         */
        name?: string;
        /**
         * {string=|function()=}
         * Html template as a string or a function that returns an html template as a string which should be used by ngView or ngInclude directives. This property takes precedence over templateUrl.
         *
         * If template is a function, it will be called with the following parameters:
         *
         * {Array.<Object>} - route parameters extracted from the current $location.path() by applying the current route
         */
        template?: string|{($routeParams?: angular.route.IRouteParamsService) : string;}
        /**
         * {string=|function()=}
         * Path or function that returns a path to an html template that should be used by ngView.
         *
         * If templateUrl is a function, it will be called with the following parameters:
         *
         * {Array.<Object>} - route parameters extracted from the current $location.path() by applying the current route
         */
        templateUrl?: string|{ ($routeParams?: angular.route.IRouteParamsService): string; }
        /**
         * {Object.<string, function>=} - An optional map of dependencies which should be injected into the controller. If any of these dependencies are promises, the router will wait for them all to be resolved or one to be rejected before the controller is instantiated. If all the promises are resolved successfully, the values of the resolved promises are injected and $routeChangeSuccess event is fired. If any of the promises are rejected the $routeChangeError event is fired. The map object is:
         *
         * - key - {string}: a name of a dependency to be injected into the controller.
         * - factory - {string|function}: If string then it is an alias for a service. Otherwise if function, then it is injected and the return value is treated as the dependency. If the result is a promise, it is resolved before its value is injected into the controller. Be aware that ngRoute.$routeParams will still refer to the previous route within these resolve functions. Use $route.current.params to access the new route parameters, instead.
         */
        resolve?: {[key: string]: any};
        /**
         * {(string|function())=}
         * Value to update $location path with and trigger route redirection.
         *
         * If redirectTo is a function, it will be called with the following parameters:
         *
         * - {Object.<string>} - route parameters extracted from the current $location.path() by applying the current route templateUrl.
         * - {string} - current $location.path()
         * - {Object} - current $location.search()
         * - The custom redirectTo function is expected to return a string which will be used to update $location.path() and $location.search().
         */
        redirectTo?: string|{($routeParams?: angular.route.IRouteParamsService, $locationPath?: string, $locationSearch?: any) : string};
        /**
         * Reload route when only $location.search() or $location.hash() changes.
         *
         * This option defaults to true. If the option is set to false and url in the browser changes, then $routeUpdate event is broadcasted on the root scope.
         */
        reloadOnSearch?: boolean;
        /**
         * Match routes without being case sensitive
         *
         * This option defaults to false. If the option is set to true, then the particular route can be matched without being case sensitive
         */
        caseInsensitiveMatch?: boolean;
    }

    // see http://docs.angularjs.org/api/ng.$route#current
    interface ICurrentRoute extends IRoute {
        locals: {
            [index: string]: any;
            $scope: IScope;
            $template: string;
        };

        params: any;
    }

    interface IRouteProvider extends IServiceProvider {
        /**
         * Sets route definition that will be used on route change when no other route definition is matched.
         *
         * @params Mapping information to be assigned to $route.current.
         */
        otherwise(params: IRoute): IRouteProvider;
        /**
         * Adds a new route definition to the $route service.
         *
         * @param path Route path (matched against $location.path). If $location.path contains redundant trailing slash or is missing one, the route will still match and the $location.path will be updated to add or drop the trailing slash to exactly match the route definition.
         *
         * - path can contain named groups starting with a colon: e.g. :name. All characters up to the next slash are matched and stored in $routeParams under the given name when the route matches.
         * - path can contain named groups starting with a colon and ending with a star: e.g.:name*. All characters are eagerly stored in $routeParams under the given name when the route matches.
         * - path can contain optional named groups with a question mark: e.g.:name?.
         *
         * For example, routes like /color/:color/largecode/:largecode*\/edit will match /color/brown/largecode/code/with/slashes/edit and extract: color: brown and largecode: code/with/slashes.
         *
         * @param route Mapping information to be assigned to $route.current on route match.
         */
        when(path: string, route: IRoute): IRouteProvider;
    }
}