NavigationReloadOptions · API reference

Import

import { NavigationReloadOptions } from "@typed/navigation";

export interface NavigationReloadOptions {
    readonly state?: unknown;
    readonly info?: unknown;
}

Reload has no history-placement choice but still needs the same state and handler metadata channels as other transitions.

This immutable options object acquires no resources and is retained only for the reload Effect.

Transient metadata delivered to navigation handlers.

Coordination data can accompany a transition without being serialized as entry state.

The transition retains this metadata only until post-commit handlers finish; it is not stored on the Destination history entry.

Application state stored with a committed destination.

Persistent entry data stays distinct from transient handler information.

The caller owns the supplied state value. A successful commit retains it on the resulting Destination; a cancelled or failed transition does not.

These import paths expose the same declaration. Each page retains its own public name and signature.