Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RouterConfig

Router configuration.

Hierarchy

  • RouterConfig

Index

Properties

Optional Mapper

Mapper: any

The URL Mapper function.

Optional addLocationChangeListener

addLocationChangeListener: any

The function to add the location change listener. Defaults to window.onpopstate = listener.

Optional createParsePath

createParsePath: createParsePath

Function that parses a path using a router library.

Optional createRouteMatcher

createRouteMatcher: any

The Feather Route Matcher function.

Optional defaultRoute

defaultRoute: Route

The default route.

Optional getPath

getPath: undefined | function

The function to get the path from the browser's location bar. Defaults to (() => document.location.hash || prefix + "/").

Optional m

m: any

The Mithril instance.

Optional prefix

prefix: undefined | string

The URL path prefix. Defaults to "#".

Optional queryString

queryString: any

routeConfig

routeConfig: RouteConfig

The route config.

Optional setPath

setPath: undefined | function

The function to set the path on the browser's location bar. Defaults to (path => window.history.pushState({}, "", path)).

Generated using TypeDoc