fix(navigation): add NavigationResult type

type NavigationResult = PipelineResult | boolean;
ref: https://discourse.aurelia.io/t/checking-for-candeactivate-before-navigatetoroute/51/2

src/interfaces.js

@@ -188,3 +188,18 @@ interface ActivationStrategy {
   */
   replace: 'replace';
 }
+
+/**
+* The result of a pipeline run.
+*/
+interface PipelineResult {
+  status: string;
+  instruction: NavigationInstruction;
+  output: any;
+  completed: boolean;
+}
+
+/**
+* The result of a router navigation.
+*/
+type NavigationResult = PipelineResult | boolean;

src/pipeline.js

@@ -1,3 +1,5 @@
+import { PipelineStep } from './interfaces';
+
 /**
 * The status of a Pipeline.
 */
@@ -48,24 +50,14 @@ interface PipelineStep {
   run(instruction: NavigationInstruction, next: Next): Promise<any>;
 }
 
-/**
-* The result of a pipeline run.
-*/
-interface PipelineResult {
-  status: string;
-  instruction: NavigationInstruction;
-  output: any;
-  completed: boolean;
-}
-
 /**
 * The class responsible for managing and processing the navigation pipeline.
 */
 export class Pipeline {
   /**
   * The pipeline steps.
   */
-  steps: Array<Function|PipelineStep> = [];
+  steps: Array<Function | PipelineStep> = [];
 
   /**
   * Adds a step to the pipeline.

src/router.js

@@ -8,7 +8,7 @@ import {
   _normalizeAbsolutePath,
   _createRootedPath,
   _resolveUrl} from './util';
-import {RouteConfig} from './interfaces';
+import {RouteConfig, NavigationResult} from './interfaces';
 
 /**
 * The primary class responsible for handling routing and navigation.
@@ -165,7 +165,7 @@ export class Router {
   * @param fragment The URL fragment to use as the navigation destination.
   * @param options The navigation options.
   */
-  navigate(fragment: string, options?: any): boolean {
+  navigate(fragment: string, options?: any): NavigationResult {
     if (!this.isConfigured && this.parent) {
       return this.parent.navigate(fragment, options);
     }
@@ -182,7 +182,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?: any): boolean {
+  navigateToRoute(route: string, params?: any, options?: any): NavigationResult {
     let path = this.generate(route, params);
     return this.navigate(path, options);
   }