tanstack-router-cache 0.1.8 → 0.1.10

package/dist/index.d.ts

@@ -2,13 +2,13 @@ import type { RouteCacheStaticOption } from "./types";
 export { RouterCacheOutlet } from "./components/router-cache-outlet";
 export type { CachedRouteData, CachedRoutes } from "./contexts/router-cache";
 export { RouterCacheProvider } from "./contexts/router-cache";
-export { defineRouteCache } from "./route-cache-static-data";
 export { useRouteCacheActive } from "./hooks/use-route-cache-active";
 export { useRouteCacheActivity } from "./hooks/use-route-cache-activity";
 export { useRouteCacheEffect } from "./hooks/use-route-cache-effect";
 export { useRouteCacheErrorBoundary } from "./hooks/use-route-cache-error-boundary";
 export { useRouteCacheNavigation } from "./hooks/use-route-cache-navigation";
 export { useRouterCache } from "./hooks/use-router-cache";
+export { defineRouteCache } from "./route-cache-static-data";
 export type * from "./types";
 declare module "@tanstack/react-router" {
     interface StaticDataRouteOption {

package/dist/route-cache-static-data.d.ts

@@ -1,5 +1,4 @@
 import type { StaticDataRouteOption } from "@tanstack/react-router";
-import type { RouteCacheRouteOptions } from "./types";
 type CachedRouteTiming = {
     createdAt?: number;
     staticData: StaticDataRouteOption;
@@ -10,7 +9,37 @@ type CachedRouteTiming = {
  * TanStack Router loader-cache options are returned at the route-option level,
  * while route-cache-specific options are stored under `staticData.routeCache`.
  */
-export declare function defineRouteCache(options?: RouteCacheRouteOptions): {
+export declare function defineRouteCache(options?: {
+    /**
+     * Maximum age, in milliseconds, for a retained route view.
+     *
+     * Expired cached views are not restored. This only controls the retained
+     * mounted view; use TanStack Router's `staleTime`, `preloadStaleTime`,
+     * and `gcTime` route options for loader-data caching.
+     *
+     * @defaultValue `Infinity`
+     */
+    maxAge?: number;
+    /**
+     * TanStack Router loader garbage-collection time, in milliseconds.
+     *
+     * This is returned as a top-level route option.
+     */
+    gcTime?: number;
+    /**
+     * TanStack Router preload freshness time, in milliseconds.
+     *
+     * This is returned as a top-level route option.
+     */
+    preloadStaleTime?: number;
+    /**
+     * TanStack Router loader freshness time, in milliseconds.
+     *
+     * This is returned as a top-level route option and does not control the
+     * retained route view lifetime. Use `maxAge` for that.
+     */
+    staleTime?: number;
+}): {
     staticData: {
         routeCache: boolean | {
             maxAge: number;

package/dist/types.d.ts

@@ -1,46 +1,22 @@
 /** Visibility mode for a cached route container. */
 export type ActivityMode = "visible" | "hidden";
-/** Route-cache options stored in TanStack Router `staticData.routeCache`. */
-export type RouteCacheOptions = {
-    /**
-     * Maximum age, in milliseconds, for a retained route view.
-     *
-     * Expired cached views are not restored. This only controls the retained
-     * mounted view; use TanStack Router's `staleTime`, `preloadStaleTime`, and
-     * `gcTime` route options for loader-data caching.
-     *
-     * @defaultValue `Infinity`
-     */
-    maxAge?: number;
-};
 /**
  * Static route-cache opt-in value.
  *
  * Use `true` to keep the route view cached with default behavior, or an object
  * when the retained view needs route-cache-specific options.
  */
-export type RouteCacheStaticOption = boolean | RouteCacheOptions;
-/** Options accepted by `defineRouteCache`. */
-export type RouteCacheRouteOptions = RouteCacheOptions & {
+export type RouteCacheStaticOption = boolean | {
     /**
-     * TanStack Router loader garbage-collection time, in milliseconds.
-     *
-     * This is returned as a top-level route option.
-     */
-    gcTime?: number;
-    /**
-     * TanStack Router preload freshness time, in milliseconds.
+     * Maximum age, in milliseconds, for a retained route view.
      *
-     * This is returned as a top-level route option.
-     */
-    preloadStaleTime?: number;
-    /**
-     * TanStack Router loader freshness time, in milliseconds.
+     * Expired cached views are not restored. This only controls the retained
+     * mounted view; use TanStack Router's `staleTime`, `preloadStaleTime`,
+     * and `gcTime` route options for loader-data caching.
      *
-     * This is returned as a top-level route option and does not control the
-     * retained route view lifetime. Use `maxAge` for that.
+     * @defaultValue `Infinity`
      */
-    staleTime?: number;
+    maxAge?: number;
 };
 /** Emitted when navigation to a ready cached route begins. */
 export type RouteCacheNavigationStart = {

package/docs/types.md

@@ -5,17 +5,11 @@
 ```ts
 export type ActivityMode = "visible" | "hidden";
 
-export type RouteCacheOptions = {
-  maxAge?: number;
-};
-
-export type RouteCacheStaticOption = boolean | RouteCacheOptions;
-
-export type RouteCacheRouteOptions = RouteCacheOptions & {
-  gcTime?: number;
-  preloadStaleTime?: number;
-  staleTime?: number;
-};
+export type RouteCacheStaticOption =
+  | boolean
+  | {
+      maxAge?: number;
+    };
 
 export type RouteCacheNavigationStart = {
   pathname: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tanstack-router-cache",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Route view caching for TanStack Router.",
   "type": "module",
   "license": "MIT",