@svelte-navigator/history/dist/memory.d.ts

History module for svelte-navigator

import type { MemoryHistory, To } from "./types";
interface MemoryHistoryObjectOptions {
    initialEntries?: To[];
    initialIndex?: number;
}
export declare type MemoryHistoryOptions = MemoryHistoryObjectOptions | string;
export declare function createMemoryHistory<State = unknown>(options?: MemoryHistoryObjectOptions): MemoryHistory<State>;
export declare function createMemoryHistory<State = unknown>(initialPath?: string): MemoryHistory<State>;
/**
 * Keep the location state of your app in memory.
 * This is mainly useful for testing if you don't run your tests
 * in a browser.
 * You could also use a memory history if you want to controll the
 * state of a widget you embed in another app using a router.
 *
 * @param {MemoryHistoryOptions} [options] Supply initial entries for
 * the history stack
 *
 * @returns {MemoryHistory} The history object
 */
export default function createMemoryHistory<State = unknown>(options?: MemoryHistoryOptions): MemoryHistory<State>;
export {};