Help Angular by taking a 1 minute survey!Go to surveyHome

UrlSegment

Represents a single URL segment.

See more...

      
      class UrlSegment {
  constructor(path: string, parameters: { [name: string]: string; })
  path: string
  parameters: {...}
  parameterMap
  toString(): string
}
    

Description

A UrlSegment is a part of a URL between the two slashes. It contains a path and the matrix parameters associated with the segment.

Constructor

constructor(path: string, parameters: { [name: string]: string; })
      
      constructor(path: string, parameters: { [name: string]: string; })
    
Parameters
path string

The path part of a URL segment

parameters object

The matrix parameters associated with a segment

Properties

Property Description
path: string Declared in constructor.

The path part of a URL segment

parameters: { [name: string]: string; } Declared in constructor.

The matrix parameters associated with a segment

parameterMap Read-only.

Methods

toString(): string
      
      toString(): string
    
Parameters

There are no parameters.

Returns

string

Usage notes

Example

@Component({templateUrl:'template.html'}) class MyComponent { constructor(router: Router) { const tree: UrlTree = router.parseUrl('/team;id=33'); const g: UrlSegmentGroup = tree.root.children[PRIMARY_OUTLET]; const s: UrlSegment[] = g.segments; s[0].path; // returns 'team' s[0].parameters; // returns {id: 33} } }
      
      @Component({templateUrl:'template.html'})
class MyComponent {
  constructor(router: Router) {
    const tree: UrlTree = router.parseUrl('/team;id=33');
    const g: UrlSegmentGroup = tree.root.children[PRIMARY_OUTLET];
    const s: UrlSegment[] = g.segments;
    s[0].path; // returns 'team'
    s[0].parameters; // returns {id: 33}
  }
}