kotlin-remix-run-router/remix.run.router/MemoryHistory

MemoryHistory

sealed external interface MemoryHistory : History(source)

A memory history stores locations in memory. This is useful in stateful environments where there is no web browser, such as node tests or React Native.

Properties

action

abstract val action: Action

The last action that modified the current location. This will always be Action.Pop when a history instance is first created. This value is mutable.

index

abstract val index: Double

The current index in the history stack.

location

abstract val location: Location<*>

The current location. This value is mutable.

Functions

createHref

abstract fun createHref(to: To): String

Returns a valid href for the given to value that may be used as the value of an attribute.

createURL

abstract fun createURL(to: To): URL

Returns a URL for the given to value

encodeLocation

abstract fun encodeLocation(to: To): Path

Encode a location the same way window.history would do (no-op for memory history) so we ensure our PUSH/REPLACE navigations for data routers behave the same as POP

abstract fun go(delta: Double)

Navigates n entries backward/forward in the history stack relative to the current index. For example, a "back" navigation would use go(-1).

listen

abstract fun listen(listener: Listener): () -> Unit

Sets up a listener that will be called whenever the current location changes.

push

abstract fun push(to: To, state: Any? = definedExternally)

Pushes a new location onto the history stack, increasing its length by one. If there were any entries in the stack after the current one, they are lost.

replace

abstract fun replace(to: To, state: Any? = definedExternally)

Replaces the current location in the history stack with a new one. The location that was replaced will no longer be available.