types Route -> RouteDescription

Author: ryansolid

.changeset/thin-wolves-learn.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/router": patch
+---
+
+types Route -> RouteDescription

src/index.tsx

@@ -29,7 +29,7 @@ export type {
   RouteLoadFunc,
   RouteLoadFuncArgs,
   RouteDefinition,
-  Route as RouteInfo,  
+  RouteDescription,
   RouteMatch,
   RouterIntegration,
   RouterUtils,

src/routing.ts

@@ -25,7 +25,7 @@ import type {
   NavigateOptions,
   Navigator,
   Params,
-  Route,
+  RouteDescription,
   RouteContext,
   RouteDefinition,
   RouteMatch,
@@ -123,7 +123,7 @@ export const useBeforeLeave = (listener: (e: BeforeLeaveEventArgs) => void) => {
   onCleanup(s);
 };
 
-export function createRoutes(routeDef: RouteDefinition, base: string = ""): Route[] {
+export function createRoutes(routeDef: RouteDefinition, base: string = ""): RouteDescription[] {
   const { component, load, children, info } = routeDef;
   const isLeaf = !children || (Array.isArray(children) && !children.length);
 
@@ -134,7 +134,7 @@ export function createRoutes(routeDef: RouteDefinition, base: string = ""): Rout
     info
   };
 
-  return asArray(routeDef.path).reduce<Route[]>((acc, originalPath) => {
+  return asArray(routeDef.path).reduce<RouteDescription[]>((acc, originalPath) => {
     for (const expandedPath of expandOptionals(originalPath)) {
       const path = joinPaths(base, expandedPath);
       let pattern = isLeaf ? path : path.split("/*", 1)[0];
@@ -155,7 +155,7 @@ export function createRoutes(routeDef: RouteDefinition, base: string = ""): Rout
   }, []);
 }
 
-export function createBranch(routes: Route[], index: number = 0): Branch {
+export function createBranch(routes: RouteDescription[], index: number = 0): Branch {
   return {
     routes,
     score: scoreRoute(routes[routes.length - 1]) * 10000 - index,
@@ -184,7 +184,7 @@ function asArray<T>(value: T | T[]): T[] {
 export function createBranches(
   routeDef: RouteDefinition | RouteDefinition[],
   base: string = "",
-  stack: Route[] = [],
+  stack: RouteDescription[] = [],
   branches: Branch[] = []
 ): Branch[] {
   const routeDefs = asArray(routeDef);

src/types.ts

@@ -113,7 +113,7 @@ export interface PathMatch {
 }
 
 export interface RouteMatch extends PathMatch {
-  route: Route;
+  route: RouteDescription;
 }
 
 export interface OutputMatch {
@@ -124,7 +124,7 @@ export interface OutputMatch {
   info?: Record<string, any>;
 }
 
-export interface Route {
+export interface RouteDescription {
   key: unknown;
   originalPath: string;
   pattern: string;
@@ -136,7 +136,7 @@ export interface Route {
 }
 
 export interface Branch {
-  routes: Route[];
+  routes: RouteDescription[];
   score: number;
   matcher: (location: string) => RouteMatch[] | null;
 }

src/utils.ts

@@ -1,5 +1,5 @@
 import { createMemo, getOwner, runWithOwner } from "solid-js";
-import type { MatchFilter, MatchFilters, Params, PathMatch, Route, SetParams } from "./types.ts";
+import type { MatchFilter, MatchFilters, Params, PathMatch, RouteDescription, SetParams } from "./types.ts";
 
 const hasSchemeRegex = /^(?:[a-z0-9]+:)?\/\//i;
 const trimPathRegex = /^\/+|(\/)\/+$/g;
@@ -114,7 +114,7 @@ function matchSegment(input: string, filter?: string | MatchFilter): boolean {
   return false;
 }
 
-export function scoreRoute(route: Route): number {
+export function scoreRoute(route: RouteDescription): number {
   const [pattern, splat] = route.pattern.split("/*", 2);
   const segments = pattern.split("/").filter(Boolean);
   return segments.reduce(