pinecone-router/dist/history.d.ts

The feature-packed router for Alpine.js.

import { type PineconeRouter } from './router';
export interface NavigationHistory {
    /**
     * The current history index
     */
    index: number;
    /**
     * The list of history entries
     */
    entries: string[];
    /**
     * Check if the router can navigate backward
     * @returns {boolean} true if the router can go back
     */
    canGoBack: () => boolean;
    /**
     * Go back to the previous route in the navigation history
     */
    back: () => void;
    /**
     * Check if the router can navigate forward
     *
     * @returns {boolean} true if the router can go forward
     */
    canGoForward: () => boolean;
    /**
     * Go to the next route in the navigation history
     */
    forward: () => void;
    /**
     * Navigate to a specific position in the navigation history
     *
     * @param index The index of the navigation position to navigate to
     * @returns void
     */
    to: (index: number) => void;
    /**
     * Push a new path to the history at the current index.
     * @internal
     * @param {string} path The path to add to the history
     * @param {boolean} pushState Whether or not to call History.pushState.
     *        Will be set to false if it's the first load or if it's called from
     *        a popstate event.
     * @returns void
     */
    push: (path: string, pushState: boolean) => void;
    /**
     * Call History.pushState or History.replaceState.
     * @internal
     * @param path The path to add to the history
     * @returns void
     */
    pushState: (path: string) => void;
    /**
     * The router instance
     * @internal
     */
    router?: PineconeRouter;
    /**
     * Set the router instance
     * @internal
     * @param router The router instance to set
     */
    setRouter: (router: PineconeRouter) => void;
}
export declare const createNavigationHistory: () => NavigationHistory;
//# sourceMappingURL=history.d.ts.map