Skip to main content

Interface: UrlStateController

Defined in: src/serialization/urlState.ts:44

Handle returned by bindStateToUrl.

Properties​

capture()​

capture: () => Record<string, unknown>

Defined in: src/serialization/urlState.ts:46

Read the current value of every binding into an { id: value } map.

Returns​

Record<string, unknown>

dispose()​

dispose: () => void

Defined in: src/serialization/urlState.ts:55

Stop listening for hashchange (when listen was enabled).

Returns​

void

restore()​

restore: () => boolean

Defined in: src/serialization/urlState.ts:53

Read the URL hash and apply it to the bindings. Returns true when a valid state was found and applied, false otherwise.

Returns​

boolean

save()​

save: () => void

Defined in: src/serialization/urlState.ts:48

Capture the current state and write it to the URL hash.

Returns​

void