W3cubDocs

/Angular

SpyLocation

class final

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
  getState(): unknown
  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()
  historyGo(relativePosition: number = 0): void
  onUrlChange(fn: (url: string, state: unknown) => void): VoidFunction
  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)`

Parameters

url string

setBaseHref()

`setBaseHref(url: string)`

Parameters

url string

path()
`path(): string` Parameters There are no parameters. Returns `string`

getState()
`getState(): unknown` Parameters There are no parameters. Returns `unknown`

isCurrentPathEqualTo()

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

Parameters

`path`	`string`
`query`	`string`	Optional. Default is `''`.

Returns

boolean

simulateUrlPop()

`simulateUrlPop(pathname: string)`

Parameters

pathname string

simulateHashChange()

`simulateHashChange(pathname: string)`

Parameters

pathname string

prepareExternalUrl()

`prepareExternalUrl(url: string): string`

Parameters

url string

Returns

string

go()

`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)`

Parameters

`path`	`string`
`query`	`string`	Optional. Default is `''`.
`state`	`any`	Optional. Default is `null`.

forward()
`forward()` Parameters There are no parameters.

back()
`back()` Parameters There are no parameters.

historyGo()

`historyGo(relativePosition: number = 0): void`

Parameters

relativePosition

number

Optional. Default is 0.

Returns

void

onUrlChange()

`onUrlChange(fn: (url: string, state: unknown) => void): VoidFunction`

Parameters

fn (url: string, state: unknown) => void

Returns

VoidFunction

`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`

Parameters

url string

Returns

string

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