History
History
This is for:
DeveloperIn this article
The History
controller is in charge of allowing navigating back and forward in the search interface history.
Methods
back
Move backward in the interface history.
Returns Promise<void>
: A promise that resolves when the previous state has been restored.
forward
Move forward in the interface history.
Returns Promise<void>
: A promise that resolves when the next state has been restored.
subscribe
Adds a callback that will be called on state change.
Parameters
-
listener:
() ⇒ void
A callback to be invoked on state change.
Returns Unsubscribe
: An unsubscribe function to remove the listener.
Attributes
state
The state relevant to the History
controller.
Initialize
buildHistory
Creates a History
controller instance.
Parameters
-
engine:
Engine
The headless engine.
Returns History
Related Types
Unsubscribe
Call signatures
-
(): void