Function routeMatch

  • Performs a match of the given pattern against the given route.

    Tries to match fragments of the given route by each of the pattern matchers, in order. If some matcher fails, the match fails too. If all matchers succeed, the match result is constructed and returned.

    Type Parameters

    • TRoute extends PathRoute

      A type of route to match against.

    Parameters

    • this: void
    • route: TRoute

      Target route to match against.

    • pattern: RoutePattern<TRoute>

      A pattern to match.

    • options: Options = {}

      Route match options.

    Returns RouteMatch<TRoute> | null

    Either successful route match object, or null if the route does not match the given pattern.

Settings

Member Visibility

Theme

Generated using TypeDoc