Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

§Enums

Action

Actions represent the type of change to a location value.

§Functions

createBrowserHistory

Browser history stores the location in regular URLs. This is the standard for most web apps, but it requires some configuration on the server to ensure you serve the same app at multiple URLs.

createClientSideURL
createHashHistory

Hash history stores the location in window.location.hash. This makes it ideal for situations where you don't want to send the location to the server for some reason, either because you do cannot configure it or the URL space is reserved for something else.

createLocation

Creates a Location object with a unique key from the given Path

createMemoryHistory

Memory history stores the current location in memory. It is designed for use in stateful non-browser environments like tests and React Native.

createPath

Creates a string URL path from the given pathname, search, and hash components.

invariant
parsePath

Parses a string URL path into its separate pathname, search, and hash components.

§Interfaces

BrowserHistory

A browser history stores the current location in regular URLs in a web browser environment. This is the standard for most web apps and provides the cleanest URLs the browser's address bar.

HashHistory

A hash history stores the current location in the fragment identifier portion of the URL in a web browser environment.

History

A history is an interface to the navigation stack. The history serves as the source of truth for the current location, as well as provides a set of methods that may be used to change it.

Listener

A function that receives notifications about location changes.

Location

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

MemoryHistory

A memory history stores locations in memory. This is useful in stateful environments where there is no web browser, such as node tests or React Native.

Path

The pathname, search, and hash values of a URL.

Update

A change to the current location.

UrlHistory

§Type Aliases

BrowserHistoryOptions
HashHistoryOptions
InitialEntry

A user-supplied object that describes a location. Used when providing entries to createMemoryHistory via its initialEntries option.

MemoryHistoryOptions
To

Describes a location that is the destination of some navigation, either via history.push or history.replace. May be either a URL or the pieces of a URL path.

UrlHistoryOptions