Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RouteContext

Exposes properties and methods for retrieving and modifying the current route context. This is passed as the first argument of the callbacks registered using {@link Router#route}.

example
const router = new Router(new BrowserHistory());

router.route("/", (context) => {

  // the first argument in this callback is the RouteContext instance
  // retrieve information about the current route

  const userId = context.params.getString("userId");
});

Hierarchy

  • RouteContext

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly hash

hash: string

The hash segment (includes the leading hash symbol ('#'))

matched

matched: string

The part of the pathname which is matched by the route path pattern. Empty string if the pathname hasn't been matched yet. You should not set this property manually. It is populated by the router.

Readonly param

param: StringMap

Exposes methods for retrieving information about the pathname segment. It is an instance of StringMap

Readonly path

path: string

The full path (pathname + query string + hash)

Readonly pathname

pathname: string

The pathname segment (includes the leading forward slash ('/'))

Readonly query

query: URLSearchParams

The URL.searchParams object parsed from the url

see

https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams

Readonly queryString

queryString: string

The query string segment (includes the leading question mark ('?'))

Accessors

state

  • get state(): unknown
  • set state(state: unknown): void

unmatched

  • get unmatched(): string

Methods

saveState

  • saveState(): void

  • Saves the state to the history object. This method is called automatically when the state is changed.

    Returns void

Generated using TypeDoc