Change return signature of router navigate() and navigateToRoute() from boolean to NavigationResult

dist/aurelia-router.d.ts

@@ -288,7 +288,7 @@ export declare class Router {
 	 * @param fragment The URL fragment to use as the navigation destination.
 	 * @param options The navigation options.
 	 */
-	navigate(fragment: string, options?: NavigationOptions): boolean;
+	navigate(fragment: string, options?: NavigationOptions): NavigationResult;
 	/**
 	 * Navigates to a new location corresponding to the route and params specified. Equivallent to [[Router.generate]] followed
 	 * by [[Router.navigate]].
@@ -297,7 +297,7 @@ export declare class Router {
 	 * @param params The route parameters to be used when populating the route pattern.
 	 * @param options The navigation options.
 	 */
-	navigateToRoute(route: string, params?: any, options?: NavigationOptions): boolean;
+	navigateToRoute(route: string, params?: any, options?: NavigationOptions): NavigationResult;
 	/**
 	 * Navigates back to the most recent location in history.
 	 */

src/router.ts

@@ -10,7 +10,7 @@ import {
   _createRootedPath,
   _resolveUrl
 } from './util';
-import { RouteConfig, RouteConfigSpecifier, ViewPortInstruction } from './interfaces';
+import { NavigationResult, RouteConfig, RouteConfigSpecifier, ViewPortInstruction } from './interfaces';
 import { PipelineProvider } from './pipeline-provider';
 
 /**@internal */
@@ -293,7 +293,7 @@ export class Router {
    * @param fragment The URL fragment to use as the navigation destination.
    * @param options The navigation options.
    */
-  navigate(fragment: string, options?: NavigationOptions): boolean {
+  navigate(fragment: string, options?: NavigationOptions): NavigationResult {
     if (!this.isConfigured && this.parent) {
       return this.parent.navigate(fragment, options);
     }
@@ -310,7 +310,7 @@ export class Router {
    * @param params The route parameters to be used when populating the route pattern.
    * @param options The navigation options.
    */
-  navigateToRoute(route: string, params?: any, options?: NavigationOptions): boolean {
+  navigateToRoute(route: string, params?: any, options?: NavigationOptions): NavigationResult {
     let path = this.generate(route, params);
     return this.navigate(path, options);
   }

test/router.spec.ts

@@ -148,6 +148,8 @@ describe('the router', () => {
   });
 
   describe('navigate', () => {
+    const delay = (milliseconds: number) => new Promise(res => setTimeout(res, milliseconds));
+
     it('should navigate to absolute paths', (done) => {
       const options = {};
       spyOn(history, 'navigate');
@@ -230,6 +232,40 @@ describe('the router', () => {
           done();
         });
     });
+
+    it('should return to caller immediately if not awaited', (done) => {
+      const options = {};
+      let navigationPending = false;
+      spyOn(history, 'navigate').and.callFake(async () => {
+        navigationPending = true;
+        await delay(10);
+        navigationPending = false;
+        done();
+      });
+
+      router.configure(config => config.map({ name: 'test', route: 'test/:id', moduleId: './test' }))
+        .then(() => {
+          router.navigateToRoute('test', { id: 123 }, options);
+          expect(navigationPending).toBe(true);
+        });
+    });
+
+    it('should return to caller after routing complete if awaited', (done) => {
+      const options = {};
+      let navigationPending = false;
+      spyOn(history, 'navigate').and.callFake(async () => {
+        navigationPending = true;
+        await delay(10);
+        navigationPending = false;
+      });
+
+      router.configure(config => config.map({ name: 'test', route: 'test/:id', moduleId: './test' }))
+        .then(async () => {
+          await router.navigateToRoute('test', { id: 123 }, options);
+          expect(navigationPending).toBe(false);
+          done();
+        });
+    });
   });
 
   describe('_createNavigationInstruction', () => {