Skip to content

docs(router): fix preloading option name to defaultPreloadGcTime #7230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pavan-sh wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(router): fix preloading option name to defaultPreloadGcTime #7230

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fb5b17
docs(router): fix preloading option name to defaultPreloadGcTime
pavan-sh Apr 20, 2026
d0834b1
Merge branch 'main' into docs/fix-preload-gc-option
pavan-sh Apr 27, 2026
569d844
Update preloaded data retention time from 30s to 30m
pavan-sh Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/router/guide/preloading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Preloading in TanStack Router is a way to load a route before the user actually

Preloaded route matches are temporarily cached in memory with a few important caveats:

- **Unused preloaded data is removed after 30 seconds by default.** This can be configured by setting the `defaultPreloadMaxAge` option on your router.
- **Unused preloaded data is removed after 30 minutes by default.** This can be configured by setting the `defaultPreloadGcTime` option on your router.
- **Obviously, when a route is loaded, its preloaded version is promoted to the router's normal pending matches state.**

If you need more control over preloading, caching and/or garbage collection of preloaded data, you should use an external caching library like [TanStack Query](https://tanstack.com/query).
Expand Down
Loading