@itznevikat/router/lib/router.d.ts

📦 Многофункциональный роутер для приложений на React и VKUI

import { Blocker, Listener } from 'history';
import { AnyDict } from './types';
/**
 * Переход к следующей странице
 * @param to URL новой страницы
 * @param meta метаданные
 */
export declare function push<T extends AnyDict>(to: string, meta?: T): void;
/**
 * Переход к следующей странице и удаление старой из истории
 * @param to URL новой страницы
 * @param meta метаданные
 */
export declare function replace<T extends AnyDict>(to: string, meta?: T): void;
/**
 * Переход назад
 */
export declare function back(): void;
/**
 * Переход впёред
 */
export declare function forward(): void;
/**
 * Переход на ±delta шагов вперёд/назад, в зависимости от знака
 * @param delta число шагов
 */
export declare function go(delta: number): void;
/**
 * Предотвращает изменение текущей локации и устанавливает слушатель, который будет вызываться вместо глобального
 * @param blocker функция, которая будет вызвана во время попытки покинуть локацию
 * @returns функция для раблокировки
 */
export declare function block(blocker: Blocker): VoidFunction;
/**
 * Прослушка событий навигации
 * @param listener слушатель
 * @returns функция для остановки слушателя
 */
export declare function listen(listener: Listener): VoidFunction;