This is the archived documentation for Angular v5. Please visit angular.io to see documentation for the current version of Angular.

RouterState

npm Package @angular/router
Module import { RouterState } from '@angular/router';
Source router/src/router_state.ts

Represents the state of the router.

Interface Overview

      
      interface RouterState extends Tree { 
  snapshot: RouterStateSnapshot
  toString(): string
}

How To Use

      
      @Component({templateUrl:'template.html'})
class MyComponent {
  constructor(router: Router) {
    const state: RouterState = router.routerState;
    const root: ActivatedRoute = state.root;
    const child = root.firstChild;
    const id: Observable<string> = child.params.map(p => p.id);
    //...
  }
}

Description

RouterState is a tree of activated routes. Every node in this tree knows about the "consumed" URL segments, the extracted parameters, and the resolved data.

See ActivatedRoute for more information.

Members

      
      snapshot: RouterStateSnapshot

The current snapshot of the router state

      
      toString(): string