effex-monorepo
    Preparing search index...

    Interface Navigation

    Navigation service for managing browser history and route state.

    interface Navigation {
        back: () => Effect<void>;
        currentMatch: Readable.Readable<CurrentMatch>;
        forward: () => Effect<void>;
        pathname: Readable.Readable<string>;
        pushPath: (path: string) => Effect<void>;
        pushRoute: <P, SP>(
            route: Route<string, P, SP, unknown, unknown, unknown>,
            options?: RouteNavigateOptions<P, SP>,
        ) => Effect<void>;
        replacePath: (path: string) => Effect<void>;
        replaceRoute: <P, SP>(
            route: Route<string, P, SP, unknown, unknown, unknown>,
            options?: RouteNavigateOptions<P, SP>,
        ) => Effect<void>;
        router: Router<any, any, any, any, any>;
        searchParams: Readable.Readable<URLSearchParams>;
    }
    Index

    Properties

    back currentMatch forward pathname pushPath pushRoute replacePath replaceRoute router searchParams

    Properties

    back: () => Effect<void>

    Go back in history

    currentMatch: Readable.Readable<CurrentMatch>

    Current matched route (if any)

    forward: () => Effect<void>

    Go forward in history

    pathname: Readable.Readable<string>

    Current pathname as a reactive readable

    pushPath: (path: string) => Effect<void>

    Navigate to a path string

    pushRoute: <P, SP>(
        route: Route<string, P, SP, unknown, unknown, unknown>,
        options?: RouteNavigateOptions<P, SP>,
    ) => Effect<void>

    Navigate to a route with type-safe params

    replacePath: (path: string) => Effect<void>

    Navigate to a path string, replacing current history entry

    replaceRoute: <P, SP>(
        route: Route<string, P, SP, unknown, unknown, unknown>,
        options?: RouteNavigateOptions<P, SP>,
    ) => Effect<void>

    Navigate to a route, replacing current history entry

    router: Router<any, any, any, any, any>

    The router this navigation is bound to

    searchParams: Readable.Readable<URLSearchParams>

    Current search params as a reactive readable

    Settings

    Member Visibility

    On This Page

    Properties