RouterCore

open external class RouterCore(source)

Properties

Link copied to clipboard
external val basepath: String?
Link copied to clipboard

Build the next ParsedLocation from navigation options without committing. Resolves to/from, params/search/hash/state, applies search validation and middlewares, and returns a stable, stringified location object.

Link copied to clipboard
external val history: RouterHistory
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external val isServer: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external val load: LoadFn
Link copied to clipboard
Link copied to clipboard
external val navigate: NavigateFn

Imperatively navigate using standard NavigateOptions. When reloadDocument or an absolute href is provided, performs a full document navigation. Otherwise, builds and commits a client-side location.

Link copied to clipboard
external val options: RouterOptions<*>
Link copied to clipboard
external val origin: String?
Link copied to clipboard
external val pathParamsDecoder: (encoded: String) -> String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external val resetNextScroll: Boolean
Link copied to clipboard
external val rewrite: LocationRewrite?
Link copied to clipboard
external val tempLocationKey: String?

Functions

Link copied to clipboard
external fun beforeLoad()
Link copied to clipboard
external fun cancelMatch(id: String)
Link copied to clipboard
external fun cancelMatches()
Link copied to clipboard
external fun clearExpiredCache()
Link copied to clipboard

Invalidate the current matches and optionally force them back into a pending state.

Link copied to clipboard
external fun hasNotFoundMatch(): Boolean
Link copied to clipboard
external fun isPrerendering(): Boolean
Link copied to clipboard
external fun isShell(): Boolean
Link copied to clipboard
external fun resolvePathWithBase(from: String, path: String): String

Resolve a path against the router basepath and trailing-slash policy.

Link copied to clipboard
external fun updateLatestLocation()