Skip to content

v6.0.0

Compare
Choose a tag to compare
@cat394 cat394 released this 27 Aug 01:15
· 70 commits to main since this release

What's changed?

  • Renamed the search property in ExtractRouteData to query.
  • Updated the path property in the ExtractRouteData type to remove query string from its value.

Example

  • Version 5

    const routeConfig = {
        products: {
            path: "/products?size"
        }
    } as const satisfies RouteConfig;
    
    type FlatResult = FlatRoutes<typeof routeConfig>;
    
    type RouteData = ExtractRouteData<FlatResult>;
    
    type ProductsRoute = RouteData["products"];
    /**
     * 
     * {
     *  path: "/products?size",
     *  params: never,
     *  search: { size: DefaultParamValue }
     * }
     * 
     */
  • Version 6

    const routeConfig = {
        products: {
            path: "/products?size"
        }
    } as const satisfies RouteConfig;
    
    type FlatResult = FlatRoutes<typeof routeConfig>;
    
    type RouteData = ExtractRouteData<FlatResult>;
    
    type ProductsRoute = RouteData["products"];
    /**
     * 
     * {
     *  path: "/products",  // NEW! Exclude query parts
     *  params: never,
     *  query: { size: DefaultParamValue } // NEW! search property -> query property
     * }
     * 
     */