History class abstract

A minimal browser-like history abstraction used by unrouter.

The contract intentionally mirrors common browser semantics:

  • push and replace update location immediately and MUST NOT trigger listeners registered via listen.
  • go / back / forward represent moving within the existing history stack. Implementations SHOULD notify listeners with a HistoryEvent when the navigation completes.
Implementers

Constructors

History()
const

Properties

action → HistoryAction
The last navigation action performed by this history.
no setter
hashCode → int
The hash code for this object.
no setterinherited
index → int
The current index in the history stack.
no setter
location → RouteInformation
The current location, including the optional per-entry RouteInformation.state.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

back() → void
Equivalent to calling go with -1.
createHref(Uri uri) → String
Formats a Uri as an href for this history implementation.
dispose() → void
Releases resources held by the history (e.g. DOM event listeners).
forward() → void
Equivalent to calling go with +1.
go(int delta) → void
Moves within the history stack by delta entries.
listen(void listener(HistoryEvent event)) → void Function()
Registers a listener that is called when a pop navigation completes.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
push(Uri uri, [Object? state]) → void
Pushes a new history entry.
replace(Uri uri, [Object? state]) → void
Replaces the current history entry.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited