W3cubDocs

/Angular 4 TypeScript

RouterState

Stable Interface

What it does

Represents the state of the router.

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

Interface Overview

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

Interface 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.

Interface Details

snapshot : RouterStateSnapshot

The current snapshot of the router state

toString() : string

exported from router/index, defined in router/src/router_state.ts

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/docs/ts/latest/api/router/index/RouterState-interface.html