feat: add a clearRoutes method

vuejs · Jun 19, 2024 · abe223d · abe223d
1 parent f7f78f0
commit abe223d
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 3 deletions.
diff --git a/packages/router/__tests__/matcher/addingRemoving.spec.ts b/packages/router/__tests__/matcher/addingRemoving.spec.ts
@@ -16,6 +16,21 @@ describe('Matcher: adding and removing records', () => {
     })
   })
 
+  it('can remove all records', () => {
+    const matcher = createRouterMatcher([], {})
+    matcher.addRoute({ path: '/', component })
+    matcher.addRoute({ path: '/about', component, name: 'about' })
+    matcher.addRoute({
+      path: '/with-children',
+      component,
+      children: [{ path: 'child', component }],
+    })
+    expect(matcher.getRoutes()).not.toHaveLength(0)
+    matcher.clearRoutes()
+    expect(matcher.getRoutes()).toHaveLength(0)
+    expect(matcher.getRecordMatcher('about')).toBeFalsy()
+  })
+
   it('throws when adding *', () => {
     const matcher = createRouterMatcher([], {})
     expect(() => {

diff --git a/packages/router/src/matcher/index.ts b/packages/router/src/matcher/index.ts
@@ -27,10 +27,9 @@ import type { RouteRecordNameGeneric, _RouteRecordProps } from '../typed-routes'
  */
 export interface RouterMatcher {
   addRoute: (record: RouteRecordRaw, parent?: RouteRecordMatcher) => () => void
-
   removeRoute(matcher: RouteRecordMatcher): void
   removeRoute(name: NonNullable<RouteRecordNameGeneric>): void
-
+  clearRoutes: () => void
   getRoutes: () => RouteRecordMatcher[]
   getRecordMatcher: (
     name: NonNullable<RouteRecordNameGeneric>
@@ -345,7 +344,19 @@ export function createRouterMatcher(
   // add initial routes
   routes.forEach(route => addRoute(route))
 
-  return { addRoute, resolve, removeRoute, getRoutes, getRecordMatcher }
+  function clearRoutes() {
+    matchers.length = 0
+    matcherMap.clear()
+  }
+
+  return {
+    addRoute,
+    resolve,
+    removeRoute,
+    clearRoutes,
+    getRoutes,
+    getRecordMatcher,
+  }
 }
 
 function paramsFromLocation(

diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts
@@ -239,6 +239,11 @@ export interface Router {
    */
   getRoutes(): RouteRecord[]
 
+  /**
+   * Delete all routes from the router matcher.
+   */
+  clearRoutes(): void
+
   /**
    * Returns the {@link RouteLocation | normalized version} of a
    * {@link RouteLocationRaw | route location}. Also includes an `href` property
@@ -1228,6 +1233,7 @@ export function createRouter(options: RouterOptions): Router {
 
     addRoute,
     removeRoute,
+    clearRoutes: matcher.clearRoutes,
     hasRoute,
     getRoutes,
     resolve,