securityos/node_modules/next/dist/client/components/navigation.d.ts

52 lines
2.1 KiB
TypeScript

declare const INTERNAL_URLSEARCHPARAMS_INSTANCE: unique symbol;
export declare class ReadonlyURLSearchParams {
[INTERNAL_URLSEARCHPARAMS_INSTANCE]: URLSearchParams;
entries: URLSearchParams['entries'];
forEach: URLSearchParams['forEach'];
get: URLSearchParams['get'];
getAll: URLSearchParams['getAll'];
has: URLSearchParams['has'];
keys: URLSearchParams['keys'];
values: URLSearchParams['values'];
toString: URLSearchParams['toString'];
size: any | URLSearchParams['size'];
constructor(urlSearchParams: URLSearchParams);
[Symbol.iterator](): IterableIterator<[string, string]>;
append(): void;
delete(): void;
set(): void;
sort(): void;
}
/**
* Get a read-only URLSearchParams object. For example searchParams.get('foo') would return 'bar' when ?foo=bar
* Learn more about URLSearchParams here: https://developer.mozilla.org/docs/Web/API/URLSearchParams
*/
export declare function useSearchParams(): ReadonlyURLSearchParams;
/**
* Get the current pathname. For example usePathname() on /dashboard?foo=bar would return "/dashboard"
*/
export declare function usePathname(): string;
export { ServerInsertedHTMLContext, useServerInsertedHTML, } from '../../shared/lib/server-inserted-html.shared-runtime';
/**
* Get the router methods. For example router.push('/dashboard')
*/
export declare function useRouter(): import('../../shared/lib/app-router-context.shared-runtime').AppRouterInstance;
interface Params {
[key: string]: string | string[];
}
/**
* Get the current parameters. For example useParams() on /dashboard/[team]
* where pathname is /dashboard/nextjs would return { team: 'nextjs' }
*/
export declare function useParams<T extends Params = Params>(): T;
/**
* Get the canonical segment path from the current level to the leaf node.
*/
export declare function useSelectedLayoutSegments(parallelRouteKey?: string): string[];
/**
* Get the segment below the current level
*/
export declare function useSelectedLayoutSegment(parallelRouteKey?: string): string | null;
export { redirect, permanentRedirect, RedirectType } from './redirect';
export { notFound } from './not-found';