svelte-pathfinder/src/index.d.ts

Tiny, state-based, advanced router for SvelteJS.

import { Writable, Readable, Updater, Unsubscriber } from 'svelte/store';

export type ParsableStoreNames = 'path' | 'query' | 'fragment';

export type Hook<T> = (
    value: T | null,
    currValue: T,
    storeName: ParsableStoreNames
) => boolean | undefined;

export interface Parsable<T> extends Readable<T> {
    set(this: void, value: T | string): void;
    update(this: void, updater: Updater<T | string>): void;
    hook(fn: Hook<T>): Unsubscriber;
}

export interface SubmitEvent extends Event {
    submitter: HTMLElement | null;
}

export interface ParseParamsOptions {
    loose?: boolean;
    sensitive?: boolean;
    blank?: boolean;
    decode?: typeof decodeURIComponent;
}

export interface Prefs {
    array: {
        separator: string;
        format: 'bracket' | 'separator';
    };
    convertTypes: boolean;
    breakHooks: boolean;
    hashbang: boolean;
    anchor: boolean | ScrollIntoViewOptions;
    scroll: boolean | ScrollIntoViewOptions;
    focus: boolean;
    nesting: number;
    sideEffect: boolean;
    base: string;
}

export type Param = string | boolean | number | {} | [] | null | undefined;

export type Params = Record<string, Param>;
export type State = Record<string, unknown>;

export declare const prefs: Prefs;
export declare const path: Parsable<string[]>;
export declare const query: Parsable<Params>;
export declare const fragment: Parsable<string>;
export declare const state: Writable<State>;
export declare const url: Readable<string>;
export declare const pattern: Readable<
    <T extends Params>(
        pattern?: string | RegExp,
        options?: ParseParamsOptions
    ) => T | null
>;

export declare function goto(url?: string | URL, data?: State): void;
export declare function redirect(url?: string | URL, data?: State): void;
export declare function back(url?: string | URL): void;
export declare function click(e: MouseEvent): void;
export declare function submit(e: SubmitEvent): void;

export declare function paramable<T extends Params>(
    pattern?: string,
    options?: ParseParamsOptions
): Writable<T>;