editLink |
---|
API Documentation / RouterMatcher
Internal RouterMatcher
• addRoute: (record
: RouteRecordRaw
, parent?
: RouteRecordMatcher
) => () => void
▸ (record
, parent?
): () => void
Name | Type |
---|---|
record |
RouteRecordRaw |
parent? |
RouteRecordMatcher |
fn
▸ (): void
void
• clearRoutes: () => void
▸ (): void
void
• getRecordMatcher: (name
: NonNullable
<RouteRecordNameGeneric
>) => undefined
| RouteRecordMatcher
▸ (name
): undefined
| RouteRecordMatcher
Name | Type |
---|---|
name |
NonNullable <RouteRecordNameGeneric > |
undefined
| RouteRecordMatcher
• getRoutes: () => RouteRecordMatcher
[]
▸ (): RouteRecordMatcher
[]
RouteRecordMatcher
[]
• 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
▸ (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
Name | Type | Description |
---|---|---|
location |
MatcherLocationRaw |
MatcherLocationRaw to resolve to a url |
currentLocation |
MatcherLocation |
MatcherLocation of the current location |
▸ removeRoute(matcher
): void
Name | Type |
---|---|
matcher |
RouteRecordMatcher |
void
▸ removeRoute(name
): void
Name | Type |
---|---|
name |
NonNullable <RouteRecordNameGeneric > |
void