Docs4dev
Docs
angular / 6 / api / common / testing / spylocation.html

SpyLocation

class

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) | null, onReturn?: (() => void) | null): SubscriptionLike
  normalize(url: string): string
}

Properties

Property Description
urlChanges: string[]

Methods

setInitialPath()

setInitialPath(url: string)

Parameters

url

Type: string.
setBaseHref()

setBaseHref(url: string)

Parameters

url

Type: string.
path()

path(): string

Parameters

There are no parameters.

Returns

string
isCurrentPathEqualTo()

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

Parameters

path

Type: string.
query

Type: string.

Optional. Default is ''.

Returns

boolean
simulateUrlPop()

simulateUrlPop(pathname: string)

Parameters

pathname

Type: string.
simulateHashChange()

simulateHashChange(pathname: string)

Parameters

pathname

Type: string.
prepareExternalUrl()

prepareExternalUrl(url: string): string

Parameters

url

Type: string.

Returns

string
go()

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

Parameters

path

Type: string.
query

Type: string.

Optional. Default is ''.
state

Type: any.

Optional. Default is null.
replaceState()

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

Parameters

path

Type: string.
query

Type: string.

Optional. Default is ''.
state

Type: any.

Optional. Default is null.
forward()

forward()

Parameters

There are no parameters.
back()

back()

Parameters

There are no parameters.
subscribe()

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

Parameters

onNext

Type: (value: any) => void.
onThrow

Type: ((error: any) => void) | null.

Optional. Default is undefined.
onReturn

Type: (() => void) | null.

Optional. Default is undefined.

Returns

SubscriptionLike
normalize()

normalize(url: string): string

Parameters

url

Type: string.

Returns

string

© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v6.angular.io/api/common/testing/SpyLocation