Interface PathMatch<ParamKey>

A PathMatch contains info about how a PathPattern matched on a URL pathname.

interface PathMatch<ParamKey> {
    params: Params<ParamKey>;
    pathname: string;
    pathnameBase: string;
    pattern: PathPattern<string>;
}

Type Parameters

ParamKey extends string = string

Index

Properties

params pathname pathnameBase pattern

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.

pattern

pattern: PathPattern<string>

The pattern that was used to match.