Interface: BrowserHistory

API / @xmachines/play-dom-router / BrowserHistory

Defined in: play-dom-router/src/create-browser-history.ts:1

Properties

Property	Modifier	Type	Description	Defined in
location	readonly	object	Get current location state	play-dom-router/src/create-browser-history.ts:5
location.hash	public	string	-	play-dom-router/src/create-browser-history.ts:8
location.pathname	public	string	-	play-dom-router/src/create-browser-history.ts:6
location.search	public	string	-	play-dom-router/src/create-browser-history.ts:7
location.state	public	unknown	-	play-dom-router/src/create-browser-history.ts:9

Methods

back()

back(): void;

Defined in: play-dom-router/src/create-browser-history.ts:26

Returns

void

---

createHref()

createHref(path): string;

Defined in: play-dom-router/src/create-browser-history.ts:38

Create href from path

Parameters

Parameter	Type
path	string

Returns

string

---

destroy()

destroy(): void;

Defined in: play-dom-router/src/create-browser-history.ts:47

Cleanup.

Safe to call more than once. When multiple wrappers share the same window.history, the original methods are restored only after the last wrapper is destroyed.

Returns

void

---

forward()

forward(): void;

Defined in: play-dom-router/src/create-browser-history.ts:27

Returns

void

---

go()

go(delta): void;

Defined in: play-dom-router/src/create-browser-history.ts:25

Go back/forward

Parameters

Parameter	Type
delta	number

Returns

void

---

push()

push(path, state?): void;

Defined in: play-dom-router/src/create-browser-history.ts:15

Push new URL to history

Parameters

Parameter	Type
path	string
state?	unknown

Returns

void

---

replace()

replace(path, state?): void;

Defined in: play-dom-router/src/create-browser-history.ts:20

Replace current URL in history

Parameters

Parameter	Type
path	string
state?	unknown

Returns

void

---

subscribe()

subscribe(listener): () => void;

Defined in: play-dom-router/src/create-browser-history.ts:33

Subscribe to history changes Returns unsubscribe function

Parameters

Parameter	Type
listener	(location) => void

Returns

() => void