@tanstack/solid-router
Version:
Modern and scalable routing for Solid applications
8 lines (7 loc) • 654 B
TypeScript
import type { AnyRouter, RegisteredRouter, RouterState } from '@tanstack/router-core';
import type { Accessor } from 'solid-js';
export interface UseLocationBaseOptions<TRouter extends AnyRouter, TSelected> {
select?: (state: RouterState<TRouter['routeTree']>['location']) => TSelected;
}
export type UseLocationResult<TRouter extends AnyRouter, TSelected> = unknown extends TSelected ? RouterState<TRouter['routeTree']>['location'] : TSelected;
export declare function useLocation<TRouter extends AnyRouter = RegisteredRouter, TSelected = unknown>(opts?: UseLocationBaseOptions<TRouter, TSelected>): Accessor<UseLocationResult<TRouter, TSelected>>;