next/dist/shared/lib/router/utils/parse-relative-url.d.ts

The React Framework

import type { ParsedUrlQuery } from 'querystring';
export interface ParsedRelativeUrl {
    auth: string | null;
    hash: string;
    host: string | null;
    hostname: string | null;
    href: string;
    pathname: string;
    port: string | null;
    protocol: string | null;
    query: ParsedUrlQuery;
    search: string;
    slashes: null;
}
/**
 * Parses path-relative urls (e.g. `/hello/world?foo=bar`). If url isn't path-relative
 * (e.g. `./hello`) then at least base must be.
 * Absolute urls are rejected with one exception, in the browser, absolute urls that are on
 * the current origin will be parsed as relative
 */
export declare function parseRelativeUrl(url: string, base?: string, parseQuery?: true): ParsedRelativeUrl;
export declare function parseRelativeUrl(url: string, base: string | undefined, parseQuery: false): Omit<ParsedRelativeUrl, 'query'>;