floppy-disk 2.3.1 → 2.4.0-beta.1

package/esm/preact/create-query.d.ts

@@ -72,7 +72,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      *
      * `"success"` = has data.
      *
-     * `"error"` = has error.
+     * `"error"` = has error and no data.
      *
      * It has no relation with network fetching state.
      * If you're looking for network fetching state, use `isWaiting` instead.
@@ -181,6 +181,17 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
+    /**
+     * Cache time in miliseconds.
+     *
+     * When a query becomes inactive (no longer have subscribers), it will be reset after this duration,
+     * and the cache data will be garbage collected.
+     *
+     * Set it to `Infinity` to disable garbage collection.
+     *
+     * Defaults to `5 * 60 * 1000` (5 minutes).
+     */
+    cacheTime?: number;
 };
 export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError>> & {
     /**

package/esm/preact/create-query.js

@@ -44,9 +44,10 @@ export const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = noop, onSubscribe = noop, onLastUnsubscribe = noop, onBeforeChangeKey = noop, defaultDeps = useQueryDefaultDeps, select = identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onSuccess = noop, onError = noop, onSettled = noop, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = noop, onError = noop, onSettled = noop, cacheTime = 5 * 60 * 1000, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
+    const resetTimeoutId = new Map();
     const preventReplaceResponse = new Map(); // Prevent optimistic data to be replaced
     const useQuery = createStores(({ get, set, key: _key, keyHash }) => {
         const key = _key;
@@ -240,6 +241,7 @@ export const createQuery = (queryFn, options = {}) => {
                 if (typeof window !== 'undefined' && fetchOnWindowFocus) {
                     window.addEventListener('focus', fetchWindowFocusHandler);
                 }
+                clearTimeout(resetTimeoutId.get(state.keyHash));
                 onFirstSubscribe(state);
             },
             onSubscribe: (state) => {
@@ -256,6 +258,11 @@ export const createQuery = (queryFn, options = {}) => {
                 useQuery.set(state.key, { retryCount: 0, retryNextPageCount: 0 }, true);
                 clearTimeout(retryTimeoutId.get(state.keyHash));
                 clearTimeout(retryNextPageTimeoutId.get(state.keyHash));
+                if (typeof window !== 'undefined' && cacheTime !== Infinity) {
+                    resetTimeoutId.set(state.keyHash, window.setTimeout(() => {
+                        useQuery.set(state.key, INITIAL_QUERY_STATE);
+                    }, cacheTime));
+                }
                 onLastUnsubscribe(state);
             },
             onBeforeChangeKey: (nextKey, prevKey) => {

package/esm/react/create-query.d.ts

@@ -71,7 +71,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      *
      * `"success"` = has data.
      *
-     * `"error"` = has error.
+     * `"error"` = has error and no data.
      *
      * It has no relation with network fetching state.
      * If you're looking for network fetching state, use `isWaiting` instead.
@@ -180,6 +180,17 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
+    /**
+     * Cache time in miliseconds.
+     *
+     * When a query becomes inactive (no longer have subscribers), it will be reset after this duration,
+     * and the cache data will be garbage collected.
+     *
+     * Set it to `Infinity` to disable garbage collection.
+     *
+     * Defaults to `5 * 60 * 1000` (5 minutes).
+     */
+    cacheTime?: number;
 };
 export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError>> & {
     /**

package/esm/react/create-query.js

@@ -43,9 +43,10 @@ export const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = noop, onSubscribe = noop, onLastUnsubscribe = noop, onBeforeChangeKey = noop, defaultDeps = useQueryDefaultDeps, select = identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onSuccess = noop, onError = noop, onSettled = noop, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = noop, onError = noop, onSettled = noop, cacheTime = 5 * 60 * 1000, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
+    const resetTimeoutId = new Map();
     const preventReplaceResponse = new Map(); // Prevent optimistic data to be replaced
     const useQuery = createStores(({ get, set, key: _key, keyHash }) => {
         const key = _key;
@@ -239,6 +240,7 @@ export const createQuery = (queryFn, options = {}) => {
                 if (typeof window !== 'undefined' && fetchOnWindowFocus) {
                     window.addEventListener('focus', fetchWindowFocusHandler);
                 }
+                clearTimeout(resetTimeoutId.get(state.keyHash));
                 onFirstSubscribe(state);
             },
             onSubscribe: (state) => {
@@ -255,6 +257,11 @@ export const createQuery = (queryFn, options = {}) => {
                 useQuery.set(state.key, { retryCount: 0, retryNextPageCount: 0 }, true);
                 clearTimeout(retryTimeoutId.get(state.keyHash));
                 clearTimeout(retryNextPageTimeoutId.get(state.keyHash));
+                if (typeof window !== 'undefined' && cacheTime !== Infinity) {
+                    resetTimeoutId.set(state.keyHash, window.setTimeout(() => {
+                        useQuery.set(state.key, INITIAL_QUERY_STATE);
+                    }, cacheTime));
+                }
                 onLastUnsubscribe(state);
             },
             onBeforeChangeKey: (nextKey, prevKey) => {

package/lib/preact/create-query.d.ts

@@ -72,7 +72,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      *
      * `"success"` = has data.
      *
-     * `"error"` = has error.
+     * `"error"` = has error and no data.
      *
      * It has no relation with network fetching state.
      * If you're looking for network fetching state, use `isWaiting` instead.
@@ -181,6 +181,17 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
+    /**
+     * Cache time in miliseconds.
+     *
+     * When a query becomes inactive (no longer have subscribers), it will be reset after this duration,
+     * and the cache data will be garbage collected.
+     *
+     * Set it to `Infinity` to disable garbage collection.
+     *
+     * Defaults to `5 * 60 * 1000` (5 minutes).
+     */
+    cacheTime?: number;
 };
 export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError>> & {
     /**

package/lib/preact/create-query.js

@@ -47,9 +47,10 @@ const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = utils_1.noop, onSubscribe = utils_1.noop, onLastUnsubscribe = utils_1.noop, onBeforeChangeKey = utils_1.noop, defaultDeps = useQueryDefaultDeps, select = utils_1.identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, cacheTime = 5 * 60 * 1000, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
+    const resetTimeoutId = new Map();
     const preventReplaceResponse = new Map(); // Prevent optimistic data to be replaced
     const useQuery = (0, create_stores_1.createStores)(({ get, set, key: _key, keyHash }) => {
         const key = _key;
@@ -243,6 +244,7 @@ const createQuery = (queryFn, options = {}) => {
                 if (typeof window !== 'undefined' && fetchOnWindowFocus) {
                     window.addEventListener('focus', fetchWindowFocusHandler);
                 }
+                clearTimeout(resetTimeoutId.get(state.keyHash));
                 onFirstSubscribe(state);
             },
             onSubscribe: (state) => {
@@ -259,6 +261,11 @@ const createQuery = (queryFn, options = {}) => {
                 useQuery.set(state.key, { retryCount: 0, retryNextPageCount: 0 }, true);
                 clearTimeout(retryTimeoutId.get(state.keyHash));
                 clearTimeout(retryNextPageTimeoutId.get(state.keyHash));
+                if (typeof window !== 'undefined' && cacheTime !== Infinity) {
+                    resetTimeoutId.set(state.keyHash, window.setTimeout(() => {
+                        useQuery.set(state.key, INITIAL_QUERY_STATE);
+                    }, cacheTime));
+                }
                 onLastUnsubscribe(state);
             },
             onBeforeChangeKey: (nextKey, prevKey) => {

package/lib/react/create-query.d.ts

@@ -71,7 +71,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      *
      * `"success"` = has data.
      *
-     * `"error"` = has error.
+     * `"error"` = has error and no data.
      *
      * It has no relation with network fetching state.
      * If you're looking for network fetching state, use `isWaiting` instead.
@@ -180,6 +180,17 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
     onSuccess?: (response: TResponse, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onError?: (error: TError, stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
     onSettled?: (stateBeforeCallQuery: QueryState<TKey, TResponse, TData, TError>) => void;
+    /**
+     * Cache time in miliseconds.
+     *
+     * When a query becomes inactive (no longer have subscribers), it will be reset after this duration,
+     * and the cache data will be garbage collected.
+     *
+     * Set it to `Infinity` to disable garbage collection.
+     *
+     * Defaults to `5 * 60 * 1000` (5 minutes).
+     */
+    cacheTime?: number;
 };
 export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError>> & {
     /**

package/lib/react/create-query.js

@@ -46,9 +46,10 @@ const createQuery = (queryFn, options = {}) => {
     const defaultFetchOnWindowFocus = options.fetchOnMount ?? true;
     const { onFirstSubscribe = utils_1.noop, onSubscribe = utils_1.noop, onLastUnsubscribe = utils_1.noop, onBeforeChangeKey = utils_1.noop, defaultDeps = useQueryDefaultDeps, select = utils_1.identityFn, staleTime = 3000, // 3 seconds
     fetchOnMount = true, fetchOnWindowFocus = defaultFetchOnWindowFocus, enabled = true, retry = 1, retryDelay = 2000, // 2 seconds
-    keepPreviousData, getNextPageParam = () => undefined, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, ...createStoresOptions } = options;
+    keepPreviousData, getNextPageParam = () => undefined, onSuccess = utils_1.noop, onError = utils_1.noop, onSettled = utils_1.noop, cacheTime = 5 * 60 * 1000, ...createStoresOptions } = options;
     const retryTimeoutId = new Map();
     const retryNextPageTimeoutId = new Map();
+    const resetTimeoutId = new Map();
     const preventReplaceResponse = new Map(); // Prevent optimistic data to be replaced
     const useQuery = (0, create_stores_1.createStores)(({ get, set, key: _key, keyHash }) => {
         const key = _key;
@@ -242,6 +243,7 @@ const createQuery = (queryFn, options = {}) => {
                 if (typeof window !== 'undefined' && fetchOnWindowFocus) {
                     window.addEventListener('focus', fetchWindowFocusHandler);
                 }
+                clearTimeout(resetTimeoutId.get(state.keyHash));
                 onFirstSubscribe(state);
             },
             onSubscribe: (state) => {
@@ -258,6 +260,11 @@ const createQuery = (queryFn, options = {}) => {
                 useQuery.set(state.key, { retryCount: 0, retryNextPageCount: 0 }, true);
                 clearTimeout(retryTimeoutId.get(state.keyHash));
                 clearTimeout(retryNextPageTimeoutId.get(state.keyHash));
+                if (typeof window !== 'undefined' && cacheTime !== Infinity) {
+                    resetTimeoutId.set(state.keyHash, window.setTimeout(() => {
+                        useQuery.set(state.key, INITIAL_QUERY_STATE);
+                    }, cacheTime));
+                }
                 onLastUnsubscribe(state);
             },
             onBeforeChangeKey: (nextKey, prevKey) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floppy-disk",
-  "version": "2.3.1",
+  "version": "2.4.0-beta.1",
   "description": "FloppyDisk - lightweight, simple, and powerful state management library",
   "keywords": [
     "state",