@flow97/react-toolkit 0.0.3 → 0.0.5

package/lib/index.d.ts

@@ -87,6 +87,11 @@ interface KeepAliveProps {
  * 使用 React 19 Activity API 实现组件状态缓存，避免路由切换时重新挂载
  * 支持路由级别的自动缓存：如果不提供 cacheKey，会自动使用当前路由路径作为缓存 key
  *
+ * **重要说明：**
+ * - React Activity 会保留组件的状态（state），组件不会被卸载和重新挂载
+ * - 但是当 Activity 从 hidden 切换到 visible 时，会重新执行副作用（useEffect）
+ * - 这意味着组件的状态会保留，但 useEffect 会重新运行，需要根据业务需求处理副作用
+ *
  * @example
  * ```tsx
  * // 手动指定缓存 key
@@ -125,8 +130,6 @@ interface KeepAliveCacheItem {
     element: ReactNode;
     /** 是否激活 */
     active: boolean;
-    /** 缓存时间戳 */
-    timestamp: number;
 }
 /**
  * KeepAlive 上下文类型
@@ -172,12 +175,15 @@ declare function useKeepAliveContext(): KeepAliveContextType;
  * useKeepAlive Hook
  * 用于控制 KeepAlive 缓存
  *
+ * 如果 KeepAliveProvider 不存在，返回 no-op 实现，不会报错
+ * 这样可以在未启用 KeepAlive 的项目中正常使用
+ *
  * @example
  * ```tsx
  * const { clearCache, removeCache, getCacheKeys } = useKeepAlive()
  *
  * const handleClearAll = () => {
- *   clearCache() // 清除所有缓存
+ *   clearCache() // 清除所有缓存（如果 KeepAliveProvider 不存在，则无操作）
  * }
  *
  * const handleClearSpecific = () => {
@@ -186,6 +192,17 @@ declare function useKeepAliveContext(): KeepAliveContextType;
  * ```
  */
 declare function useKeepAlive(): {
+    cache: any;
+    removeCache: () => void;
+    clearCache: () => void;
+    clearCacheByPath: () => void;
+    clearCurrentCache: () => void;
+    getCacheKeys: () => never[];
+    getAllCache: () => never[];
+    getCache: () => undefined;
+    activateCache: () => void;
+    deactivateCache: () => void;
+} | {
     cache: Map<string, KeepAliveCacheItem>;
     removeCache: (key: string) => void;
     clearCache: () => void;