@tanstack/router-core
Version:
Modern and scalable routing for React applications
33 lines (32 loc) • 1.22 kB
TypeScript
import { RouteIds } from './routeInfo.js';
import { RegisteredRouter } from './router.js';
export type NotFoundError = {
/**
@deprecated
Use `routeId: rootRouteId` instead
*/
global?: boolean;
/**
@private
Do not use this. It's used internally to indicate a path matching error
*/
_global?: boolean;
data?: any;
throw?: boolean;
routeId?: RouteIds<RegisteredRouter['routeTree']>;
headers?: HeadersInit;
};
/**
* Create a not-found error object recognized by TanStack Router.
*
* Throw this from loaders/actions to trigger the nearest `notFoundComponent`.
* Use `routeId` to target a specific route's not-found boundary. If `throw`
* is true, the error is thrown instead of returned.
*
* @param options Optional settings including `routeId`, `headers`, and `throw`.
* @returns A not-found error object that can be thrown or returned.
* @link https://tanstack.com/router/latest/docs/router/framework/react/api/router/notFoundFunction
*/
export declare function notFound(options?: NotFoundError): NotFoundError;
/** Determine if a value is a TanStack Router not-found error. */
export declare function isNotFound(obj: any): obj is NotFoundError;