internal_.PartialLocation

runtime / <internal> / PartialLocation

Interface: PartialLocation<S>

internal.PartialLocation

A partial Location object that may be missing some properties.

Type parameters

Name	Type
S	extends State = State

Hierarchy

• PartialPath

  ↳ PartialLocation

Table of contents

Properties

• hash
• key
• pathname
• query
• search
• state

Properties

hash

• Optional hash: string

The URL fragment identifier, beginning with a #.

Inherited from

PartialPath.hash

---

key

• Optional 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

• Optional pathname: string

The URL pathname, beginning with a /.

Inherited from

PartialPath.pathname

---

query

• Optional query: ParsedQuery<string>

The parsed URL search Object.

Inherited from

PartialPath.query

---

search

• Optional search: string

The URL search string, beginning with a ?.

Inherited from

PartialPath.search

---

state

• Optional state: S

An object of arbitrary data associated with this location.