• Preparing search index...
  • The search index is not available
React Router API Reference
  • React Router API Reference
  • react-router
  • matchRoutes

Function matchRoutes

  • matchRoutes<RouteObjectType>(routes, locationArg, basename?): AgnosticRouteMatch<string, RouteObjectType>[] | null
  • Matches the given routes to a location and returns the match data.

    Type Parameters

    • RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject

    Parameters

    • routes: RouteObjectType[]
    • locationArg: string | Partial<Location<any>>
    • basename: string = "/"

    Returns AgnosticRouteMatch<string, RouteObjectType>[] | null

    • Defined in packages/react-router/lib/router/utils.ts:506

Settings

Member Visibility
React Router API Reference
  • Loading...

Generated using TypeDoc