Module / v1.0.0-beta.13

@typed/navigation

28 unique exports available through this public import path, including their members and aliases.

import * as navigation from "@typed/navigation";

Backend history state

  • NavigationState

    type-alias

    Stores the backend-neutral history list, active index, and optional pending transition.

  • makeNavigationCore

    variable

    Builds the Navigation service state machine around a provider-specific commit Effect.

Blocking decisions

  • Blocking

    interface

    Presents one blocked transition and the three ways its owner can settle it.

Blocking policy

  • UseBlockNavigationParams

    interface

    Configures the optional Effectful predicate used before a transition is blocked.

  • useBlockNavigation

    variable

    Registers a scoped navigation blocker and returns renderer-independent blocking state.

Blocking state

  • BlockNavigation

    interface

    Exposes the currently blocked transition as reactive state plus an isBlocking projection.

Browser history provider

  • fromWindow

    variable

    Provides Navigation by adapting a browser Window’s History API and popstate events.

Command options

Current destination

  • CurrentPath

    variable

    Reactively exposes the current pathname and search string, excluding origin and hash.

Destination schemas

  • Destination

    variable

    Describes a committed history entry with stable id and key identity.

  • ProposedDestination

    variable

    Describes a destination before the navigation backend assigns stable entry identity.

Memory history configuration

  • InitialMemoryOptions

    interface

    Configures an in-memory provider from one initial URL.

  • MemoryOptions

    interface

    Configures an in-memory navigation provider from already committed entries.

Memory history providers

  • initialMemory

    variable

    Provides Navigation from one URL with generated entry identity.

  • memory

    variable

    Provides Navigation from an in-memory history state.

Navigation event schemas

  • BeforeNavigationEvent

    variable

    Describes the pre-commit event presented to navigation guards.

  • NavigationEvent

    variable

    Describes a destination after it has been committed by the navigation backend.

Navigation failures

  • NavigationError

    class

    Wraps malformed URLs, unknown traversal keys, identifier failures, and backend history failures.

Navigation hooks

Navigation service

  • Navigation

    class

    Provides backend-neutral reactive navigation state and Effectful history operations.

Transition control

  • CancelNavigation

    class

    Signals that a pre-navigation handler rejects the pending transition.

  • RedirectError

    class

    Signals that a pre-navigation handler wants to replace the pending destination.

Transition schemas

  • NavigationType

    variable

    Validates the four transition operations understood by navigation providers.

  • Transition

    variable

    Describes the currently proposed navigation before handlers and commit finish.

URL resolution

  • getUrl

    variable

    Resolves a path or URL value against an absolute origin.