ParamMap

interface

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

Interface Overview

interface ParamMap { 
  has(name: string): boolean
  get(name: string): string | null
  getAll(name: string): string[]
  get keys: string[]
}

Description

Matrix and Query parameters.

ParamMap makes it easier to work with parameters as they could have either a single value or multiple value. Because this should be known by the user, calling get or getAll returns the correct type (either string or string[]).

The API is inspired by the URLSearchParams interface. see https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams

Members

has(name: string): boolean

get(name: string): string | null

Return a single value for the given parameter name:

• the value when the parameter has a single value,
• the first value if the parameter has multiple values,
• null when there is no such parameter.

getAll(name: string): string[]

Return an array of values for the given parameter name.

If there is no such parameter, an empty array is returned.

get keys: string[]

Name of the parameters