Skip to content

vue-router / RouterMatcher

RouterMatcher

Internal

Internal RouterMatcher

Properties

addRoute()

ts
addRoute: (record, parent?) => () => void;

Parameters

record

RouteRecordRaw

parent?

RouteRecordMatcher

Returns

ts
(): void;
Returns

void


clearRoutes()

ts
clearRoutes: () => void;

Returns

void


getRecordMatcher()

ts
getRecordMatcher: (name) => undefined | RouteRecordMatcher;

Parameters

name

NonNullable<RouteRecordNameGeneric>

Returns

undefined | RouteRecordMatcher


getRoutes()

ts
getRoutes: () => RouteRecordMatcher[];

Returns

RouteRecordMatcher[]


resolve()

ts
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

MatcherLocation

Methods

removeRoute()

Call Signature

ts
removeRoute(matcher): void;
Parameters
matcher

RouteRecordMatcher

Returns

void

Call Signature

ts
removeRoute(name): void;
Parameters
name

NonNullable<RouteRecordNameGeneric>

Returns

void

Released under the MIT License.