RouterState

Represents the state of the router as a tree of activated routes.

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

See also

• ActivatedRoute

• Getting route information

Constructor

constructor(root: TreeNode<ActivatedRoute>, snapshot: RouterStateSnapshot) Parameters root TreeNode snapshot RouterStateSnapshot The current snapshot of the router state

Properties

Property	Description
snapshot: RouterStateSnapshot	Declared in Constructor The current snapshot of the router state

Methods

toString()
toString(): string Parameters There are no parameters. Returns string

Usage notes

Every node in the route tree is an ActivatedRoute instance that knows about the "consumed" URL segments, the extracted parameters, and the resolved data. Use the ActivatedRoute properties to traverse the tree from any node.

The following fragment shows how a component gets the root node of the current state to establish its own route tree:

@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);
    //...
  }
}