state-in-url/dist/useUrlStateBase/useUrlStateBase.d.ts

Store state in URL as in object, types and structure are preserved, with TS validation. Same API as React.useState, wthout any hasssle or boilerplate. Next.js@14-16, react-router@6-7, remix@2, and Astro.

import { useUrlEncode } from '../useUrlEncode';
import { type JSONCompatible, type Router } from '../utils';
declare function isWriteWaitingHere(): boolean;
export declare function useUrlStateBase<T extends JSONCompatible>(defaultState: T, router: Router, getInitialState?: ({ parse, }: {
    parse: ReturnType<typeof useUrlEncode<T>>['parse'];
}) => T, basename?: string, canSeedFromUrl?: boolean): {
    updateState: (value: Partial<T> | ((currState: T, defaultState: T) => T)) => void;
    updateUrl: (value?: Parameters<(value: Partial<T> | ((currState: T, defaultState: T) => T)) => void>[0], options?: Options) => void;
    state: T;
    reset: (options?: Options) => void;
    getState: () => T;
    pendingUrlUpdate: typeof isWriteWaitingHere;
};
interface OptionsObject {
    [key: string]: unknown;
}
export interface Options extends OptionsObject {
    replace?: boolean;
}
export {};