@types/hookrouter
TypeScript icon, indicating that this package has built-in type declarations

2.2.8 • Public • Published

Installation

npm install --save @types/hookrouter

Summary

This package contains type definitions for hookrouter (https://github.com/Paratron/hookrouter).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hookrouter.

index.d.ts

import * as React from "react";
export namespace HookRouter {
    type InterceptedPath = string | null;
    interface AProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
        href: string;
    }
    interface QueryParams {
        [key: string]: any;
    }
    interface RouteObject<T = any> {
        [key: string]: (params: QueryParams) => T;
    }
}
export function setLinkProps(props: HookRouter.AProps): HookRouter.AProps;
export function A(props: HookRouter.AProps): React.ReactHTMLElement<HTMLAnchorElement>;
export function confirmNavigation(): void;
export function resetPath(): void;
export function stopInterception(): void;
export function useControlledInterceptor(): [
    HookRouter.InterceptedPath,
    typeof confirmNavigation,
    typeof resetPath,
    typeof stopInterception,
];
export function interceptRoute(previousRoute: string, nextRoute: string): string[];
export function get(componentId: number): HookRouter.RouteObject | null;
export function remove(componentId: number): void;
export function useInterceptor(handlerFn: (currentPath: string, nextPath: string) => string): () => typeof remove;
export function setQueryParams(inObj: HookRouter.QueryParams, replace?: boolean): void;
export function getQueryParams(): HookRouter.QueryParams;
export function queryStringToObject(inStr: string): HookRouter.QueryParams;
export function objectToQueryString(inObj: HookRouter.QueryParams): string;
export function useQueryParams(): [HookRouter.QueryParams, typeof setQueryParams];
export function useRedirect(
    fromURL: string,
    toURL: string,
    queryParams?: HookRouter.QueryParams | null,
    replace?: boolean,
): void;
export function setBasepath(inBasepath: string): void;
export function getBasepath(): string;
export function resolvePath(inPath: string): string;
export function prepareRoute(inRoute: string): [RegExp, string[]];
export function navigate(
    url: string,
    replace?: boolean,
    queryParams?: HookRouter.QueryParams | null,
    replaceQueryParams?: boolean,
): void;
export function setPath(inPath: string): void;
export function getPath(): string;
export function usePath(active?: boolean, withBasePath?: boolean): string;
export function updatePathHooks(): void;
export function getWorkingPath(parentRouterId: string): string;
export function useRoutes<T = any>(routeObj: HookRouter.RouteObject<T>): T | null;
export function useTitle(inString: string): void;
export function getTitle(): string;

Additional Details

Credits

These definitions were written by Mete Can Eris, and Sam Calvert.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/hookrouter

Weekly Downloads

1,807

Version

2.2.8

License

MIT

Unpacked Size

7.85 kB

Total Files

5

Last publish

Collaborators

  • types