@tanstack/router-core/dist/esm/location.d.ts

Modern and scalable routing for React applications

import { ParsedHistoryState } from '@tanstack/history';
import { AnySchema } from './validators.js';
export interface ParsedLocation<TSearchObj extends AnySchema = {}> {
    /**
     * The full path of the location, including pathname, search, and hash.
     * Does not include the origin. Is the equivalent of calling
     * `url.replace(url.origin, '')`
     */
    href: string;
    /**
     * @description The pathname of the location, including the leading slash.
     */
    pathname: string;
    /**
     * The parsed search parameters of the location in object form.
     */
    search: TSearchObj;
    /**
     * The search string of the location, including the leading question mark.
     */
    searchStr: string;
    /**
     * The in-memory state of the location as it *may* exist in the browser's history.
     */
    state: ParsedHistoryState;
    /**
     * The hash of the location, excluding the leading hash character.
     * (e.g., '123' instead of '#123')
     */
    hash: string;
    /**
     * The masked location of the location.
     */
    maskedLocation?: ParsedLocation<TSearchObj>;
    /**
     * Whether to unmask the location on reload.
     */
    unmaskOnReload?: boolean;
    /**
     * @private
     * @description The public href of the location.
     * If a rewrite is applied, the `href` property will be the rewritten URL.
     */
    publicHref: string;
    /**
     * @private
     * @description Whether the publicHref is external (different origin from rewrite).
     */
    external: boolean;
}