{ "id": "api/common/testing/MockLocationStrategy", "title": "MockLocationStrategy", "contents": "\n\n
\n
\n
\n \n API > @angular/common > @angular/common/testing\n
\n \n
\n \n
\n

MockLocationStrategylink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

A mock implementation of LocationStrategy that allows tests to fire simulated\nlocation events.

\n\n \n
\n \n \n \n
\n\nclass MockLocationStrategy extends LocationStrategy {\n internalBaseHref: string\n internalPath: string\n internalTitle: string\n urlChanges: string[]\n simulatePopState(url: string): void\n path(includeHash: boolean = false): string\n prepareExternalUrl(internal: string): string\n pushState(ctx: any, title: string, path: string, query: string): void\n replaceState(ctx: any, title: string, path: string, query: string): void\n onPopState(fn: (value: any) => void): void\n getBaseHref(): string\n back(): void\n forward(): void\n getState(): unknown\n\n // inherited from common/LocationStrategy\n abstract path(includeHash?: boolean): string\n abstract prepareExternalUrl(internal: string): string\n abstract pushState(state: any, title: string, url: string, queryParams: string): void\n abstract replaceState(state: any, title: string, url: string, queryParams: string): void\n abstract forward(): void\n abstract back(): void\n abstract onPopState(fn: LocationChangeListener): void\n abstract getBaseHref(): string\n}\n\n\n \n \n\n
\n\n\n \n\n \n \n \n\n\n\n\n\n\n\n\n
\n

Propertieslink

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyDescription
\n \n internalBaseHref: string\n \n \n \n \n
\n \n internalPath: string\n \n \n \n \n
\n \n internalTitle: string\n \n \n \n \n
\n \n urlChanges: string[]\n \n \n \n \n
\n
\n\n\n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n simulatePopState()\n \n link

\n \n
\n
\n
\n \n\n simulatePopState(url: string): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n url\n string\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n path()\n \n link

\n \n
\n
\n
\n \n\n path(includeHash: boolean = false): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n includeHash\n boolean\n

Optional. Default is false.

\n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n prepareExternalUrl()\n \n link

\n \n
\n
\n
\n \n\n prepareExternalUrl(internal: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n internal\n string\n \n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n pushState()\n \n link

\n \n
\n
\n
\n \n\n pushState(ctx: any, title: string, path: string, query: string): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n ctx\n any\n \n \n
\n \n title\n string\n \n \n
\n \n path\n string\n \n \n
\n \n query\n string\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n replaceState()\n \n link

\n \n
\n
\n
\n \n\n replaceState(ctx: any, title: string, path: string, query: string): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n ctx\n any\n \n \n
\n \n title\n string\n \n \n
\n \n path\n string\n \n \n
\n \n query\n string\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n onPopState()\n \n link

\n \n
\n
\n
\n \n\n onPopState(fn: (value: any) => void): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n fn\n (value: any) => void\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getBaseHref()\n \n link

\n \n
\n
\n
\n \n\n getBaseHref(): string\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n back()\n \n link

\n \n
\n
\n
\n \n\n back(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n forward()\n \n link

\n \n
\n
\n
\n \n\n forward(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getState()\n \n link

\n \n
\n
\n
\n \n\n getState(): unknown\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

unknown

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n\n \n\n\n
\n
\n\n\n" }