Skip to content

resolve-path.md

Latest commit

 

History

History
31 lines (22 loc) · 881 Bytes

resolve-path.md

File metadata and controls

31 lines (22 loc) · 881 Bytes
title resolvePath

resolvePath

Type declaration 
declare function resolvePath(
  to: To,
  fromPathname?: string
): Path;

type To = Partial<Location> | string;

interface Path {
  pathname: string;
  search: string;
  hash: string;
}

resolvePath resolves a given To value into an actual Path object with an absolute pathname. This is useful whenever you need to know the exact path for a relative To value. For example, the <Link> component uses this function to know the actual URL it points to.

The useResolvedPath hook uses resolvePath internally to resolve the pathname. If to contains a pathname, it is resolved against the current route pathname. Otherwise, it is resolved against the current URL (location.pathname).