W3cubDocs

/Angular

RouterStateSnapshot

class final

Represents the state of the router at a moment in time.

See more...

class RouterStateSnapshot extends Tree<ActivatedRouteSnapshot> {
  url: string
  override
  toString(): string
}

Description

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

The following example shows how a component is initialized with information from the snapshot of the root node's state at the time of creation.

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

Constructor

constructor(url: string, root: TreeNode<ActivatedRouteSnapshot>)

Parameters
url string

The url from which this snapshot was created

root TreeNode

Properties

Property Description
url: string Declared in Constructor

The url from which this snapshot was created

override

Methods

toString(): string

Parameters

There are no parameters.

Returns

string

© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/router/RouterStateSnapshot