import type { RouteTree } from './segment-cache/cache'; import type { CacheNode, FlightRouterState } from '../../shared/lib/app-router-types'; export type RouterBFCacheEntry = { tree: FlightRouterState; renderTree: RouteTree; stateKey: string; next: RouterBFCacheEntry | null; }; /** * Keeps track of the most recent N trees (FlightRouterStates) that were active * at a certain segment level. E.g. for a segment "/a/b/[param]", this hook * tracks the last N param values that the router rendered for N. * * The result of this hook precisely determines the number and order of * trees that are rendered in parallel at their segment level. * * The purpose of this cache is to we can preserve the React and DOM state of * some number of inactive trees, by rendering them in an boundary. * That means it would not make sense for the the lifetime of the cache to be * any longer than the lifetime of the React tree; e.g. if the hook were * unmounted, then the React tree would be, too. So, we use React state to * manage it. * * Each entry retains its render tree, including its RSC data. This hook * determines which trees should have their React and DOM state preserved * by . */ export declare function useRouterBFCache(activeTree: FlightRouterState, activeRenderTree: RouteTree, activeStateKey: string): RouterBFCacheEntry;