@westacks/vortex/dist/page.d.ts

Server-based routing for SPAs

/**
 * Page instance
 */
export type Page = {
    component: string;
    props: Record<string, unknown>;
    url: string;
    version: string | null;
    clearHistory: boolean;
    encryptHistory: boolean;
    deferredProps?: Record<string, string[]>;
    mergeProps?: string[];
    deepMergeProps?: string[];
};
/**
 * Get current page
 *
 * @returns Current page
 */
export declare const getPage: import('./signals').SignalGetter<Page>;
/**
 * Set current page
 *
 * @param page Page instance
 */
export declare const setPage: import('./signals').SignalSetter<Page>;
/**
 * Subscribe to page changes
 * @param fn Callback function will be executed each time the page changes
 * @returns Destructor function that disposes the effect
 */
export declare const subscribe: (fn: (page: Page) => void) => () => void;