Skip to content

Commit 68daf0e

Browse files
refactor: simplify route cache option types
1 parent 76fd114 commit 68daf0e

3 files changed

Lines changed: 24 additions & 31 deletions

File tree

docs/types.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,6 @@ export type RouteCacheOptions = {
1111

1212
export type RouteCacheStaticOption = boolean | RouteCacheOptions;
1313

14-
export type RouteCacheRouteOptions = RouteCacheOptions & {
15-
gcTime?: number;
16-
preloadStaleTime?: number;
17-
staleTime?: number;
18-
};
19-
2014
export type RouteCacheNavigationStart = {
2115
pathname: string;
2216
startedAt: number;

src/route-cache-static-data.ts

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { StaticDataRouteOption } from "@tanstack/react-router";
2-
import type { RouteCacheOptions, RouteCacheRouteOptions } from "./types";
2+
import type { RouteCacheOptions } from "./types";
33

44
const DEFAULT_ROUTE_CACHE_MAX_AGE = Number.POSITIVE_INFINITY;
55

@@ -28,7 +28,29 @@ function getRouteCacheOptions(
2828
* TanStack Router loader-cache options are returned at the route-option level,
2929
* while route-cache-specific options are stored under `staticData.routeCache`.
3030
*/
31-
export function defineRouteCache(options: RouteCacheRouteOptions = {}) {
31+
export function defineRouteCache(
32+
options: RouteCacheOptions & {
33+
/**
34+
* TanStack Router loader garbage-collection time, in milliseconds.
35+
*
36+
* This is returned as a top-level route option.
37+
*/
38+
gcTime?: number;
39+
/**
40+
* TanStack Router preload freshness time, in milliseconds.
41+
*
42+
* This is returned as a top-level route option.
43+
*/
44+
preloadStaleTime?: number;
45+
/**
46+
* TanStack Router loader freshness time, in milliseconds.
47+
*
48+
* This is returned as a top-level route option and does not control the
49+
* retained route view lifetime. Use `maxAge` for that.
50+
*/
51+
staleTime?: number;
52+
} = {}
53+
) {
3254
const { gcTime, maxAge, preloadStaleTime, staleTime } = options;
3355

3456
return {

src/types.ts

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,6 @@ export type RouteCacheOptions = {
2323
*/
2424
export type RouteCacheStaticOption = boolean | RouteCacheOptions;
2525

26-
/** Options accepted by `defineRouteCache`. */
27-
export type RouteCacheRouteOptions = RouteCacheOptions & {
28-
/**
29-
* TanStack Router loader garbage-collection time, in milliseconds.
30-
*
31-
* This is returned as a top-level route option.
32-
*/
33-
gcTime?: number;
34-
/**
35-
* TanStack Router preload freshness time, in milliseconds.
36-
*
37-
* This is returned as a top-level route option.
38-
*/
39-
preloadStaleTime?: number;
40-
/**
41-
* TanStack Router loader freshness time, in milliseconds.
42-
*
43-
* This is returned as a top-level route option and does not control the
44-
* retained route view lifetime. Use `maxAge` for that.
45-
*/
46-
staleTime?: number;
47-
};
48-
4926
/** Emitted when navigation to a ready cached route begins. */
5027
export type RouteCacheNavigationStart = {
5128
/** Normalized pathname for the cached route being restored. */

0 commit comments

Comments
 (0)