Help Angular by taking a 1 minute survey!Go to surveyHome
API > @angular/common > @angular/common/testing

SpyLocation

A spy for Location that allows tests to fire simulated location events.

      
      class SpyLocation implements Location {
  urlChanges: string[]
  setInitialPath(url: string)
  setBaseHref(url: string)
  path(): string
  isCurrentPathEqualTo(path: string, query: string = ''): boolean
  simulateUrlPop(pathname: string)
  simulateHashChange(pathname: string)
  prepareExternalUrl(url: string): string
  go(path: string, query: string = '', state: any = null)
  replaceState(path: string, query: string = '', state: any = null)
  forward()
  back()
  subscribe(onNext: (value: any) => void, onThrow?: (error: any) => void, onReturn?: () => void): SubscriptionLike
  normalize(url: string): string
}

Properties

Property Description
urlChanges: string[]

Methods

setInitialPath()

setInitialPath(url: string)
      
      setInitialPath(url: string)
Parameters
url string

setBaseHref()

setBaseHref(url: string)
      
      setBaseHref(url: string)
Parameters
url string

path()

path(): string
      
      path(): string
Parameters

There are no parameters.

Returns

string

isCurrentPathEqualTo()

isCurrentPathEqualTo(path: string, query: string = ''): boolean
      
      isCurrentPathEqualTo(path: string, query: string = ''): boolean
Parameters
path string
query string

Optional. Default is ''.
Returns

boolean

simulateUrlPop()

simulateUrlPop(pathname: string)
      
      simulateUrlPop(pathname: string)
Parameters
pathname string

simulateHashChange()

simulateHashChange(pathname: string)
      
      simulateHashChange(pathname: string)
Parameters
pathname string

prepareExternalUrl()

prepareExternalUrl(url: string): string
      
      prepareExternalUrl(url: string): string
Parameters
url string
Returns

string

go()

go(path: string, query: string = '', state: any = null)
      
      go(path: string, query: string = '', state: any = null)
Parameters
path string
query string

Optional. Default is ''.
state any

Optional. Default is null.

replaceState()

replaceState(path: string, query: string = '', state: any = null)
      
      replaceState(path: string, query: string = '', state: any = null)
Parameters
path string
query string

Optional. Default is ''.
state any

Optional. Default is null.

forward()

forward()
      
      forward()
Parameters

There are no parameters.

back()

back()
      
      back()
Parameters

There are no parameters.

subscribe()

subscribe(onNext: (value: any) => void, onThrow?: (error: any) => void, onReturn?: () => void): SubscriptionLike
      
      subscribe(onNext: (value: any) => void, onThrow?: (error: any) => void, onReturn?: () => void): SubscriptionLike
Parameters
onNext (value: any) => void
onThrow (error: any) => void

Optional. Default is undefined.
onReturn () => void

Optional. Default is undefined.
Returns

SubscriptionLike

normalize()

normalize(url: string): string
      
      normalize(url: string): string
Parameters
url string
Returns

string