Interface Location<State>

An entry in a history stack. A location contains information about the URL path, as well as possibly some arbitrary state and a key.

interface Location<State = any> {
    hash: string;
    key: string;
    pathname: string;
    search: string;
    state: State;
}

Properties

hash: string

A URL fragment identifier, beginning with a #.

key: string

A unique string associated with this location. May be used to safely store and retrieve data in some other storage API, like localStorage.

Note: This value is always "default" on the initial location.

pathname: string

A URL pathname, beginning with a /.

search: string

A URL search string, beginning with a ?.

state: State

A value of arbitrary data associated with this location.