Interface RouteMatch<ParamKey, RouteObjectType>

interface RouteMatch<
    ParamKey extends string = string,
    RouteObjectType extends RouteObject = RouteObject,
> {
    params: Params<ParamKey>;
    pathname: string;
    pathnameBase: string;
    route: RouteObjectType;
}

Type Parameters

ParamKey extends string = string
RouteObjectType extends RouteObject = RouteObject

Hierarchy (View Summary)

AgnosticRouteMatch<ParamKey, RouteObjectType>
- RouteMatch
  - DataRouteMatch

Index

Properties

params pathname pathnameBase route

Properties

params

params: Params<ParamKey>

The names and values of dynamic parameters in the URL.

pathname

pathname: string

The portion of the URL pathname that was matched.

pathnameBase

pathnameBase: string

The portion of the URL pathname that was matched before child routes.

route

route: RouteObjectType

The route object that was used to match.