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