Become a sponsor
API Documentation • Docs
API Documentation / RouterMatcher
Interface: RouterMatcher
Internal
Internal RouterMatcher
Properties
addRoute()
addRoute: (
record,parent?) => () =>void
Parameters
• record: RouteRecordRaw
• parent?: RouteRecordMatcher
Returns
Function
Returns
void
clearRoutes()
clearRoutes: () =>
void
Returns
void
getRecordMatcher()
getRecordMatcher: (
name) =>undefined|RouteRecordMatcher
Parameters
• name: NonNullable<RouteRecordNameGeneric>
Returns
undefined | RouteRecordMatcher
getRoutes()
getRoutes: () =>
RouteRecordMatcher[]
Returns
RouteRecordMatcher[]
resolve()
resolve: (
location,currentLocation) =>MatcherLocation
Resolves a location. Gives access to the route record that corresponds to the actual path as well as filling the corresponding params objects
Parameters
• location: MatcherLocationRaw
MatcherLocationRaw to resolve to a url
• currentLocation: MatcherLocation
MatcherLocation of the current location
Returns
Methods
removeRoute()
removeRoute(matcher)
removeRoute(
matcher):void
Parameters
• matcher: RouteRecordMatcher
Returns
void
removeRoute(name)
removeRoute(
name):void
Parameters
• name: NonNullable<RouteRecordNameGeneric>
Returns
void