optimistic in hooks

hazae41 · Sep 3, 2022 · ea171e5 · ea171e5
1 parent 8de5f0e
commit ea171e5
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 13 deletions.
diff --git a/dist/index.esm.js b/dist/index.esm.js
@@ -1423,10 +1423,10 @@ function useScroll(scroller, fetcher, params) {
             }
         });
     }); }, [core, skey]);
-    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter;
+    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter, optimistic = _b.optimistic;
     var ready = state !== null;
     var loading = Boolean(aborter);
-    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, scroll: scroll, clear: clear };
+    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, optimistic: optimistic, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, scroll: scroll, clear: clear };
 }
 
 /**
@@ -1502,10 +1502,10 @@ function useSingle(key, poster, params) {
             }
         });
     }); }, [core, skey]);
-    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter;
+    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter, optimistic = _b.optimistic;
     var ready = state !== null;
     var loading = Boolean(aborter);
-    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, update: update, clear: clear };
+    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, optimistic: optimistic, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, update: update, clear: clear };
 }
 
 function use(factory, deps) {

diff --git a/dist/index.js b/dist/index.js
@@ -1429,10 +1429,10 @@ function useScroll(scroller, fetcher, params) {
             }
         });
     }); }, [core, skey]);
-    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter;
+    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter, optimistic = _b.optimistic;
     var ready = state !== null;
     var loading = Boolean(aborter);
-    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, scroll: scroll, clear: clear };
+    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, optimistic: optimistic, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, scroll: scroll, clear: clear };
 }
 
 /**
@@ -1508,10 +1508,10 @@ function useSingle(key, poster, params) {
             }
         });
     }); }, [core, skey]);
-    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter;
+    var _b = state !== null && state !== void 0 ? state : {}, data = _b.data, error = _b.error, time = _b.time, cooldown = _b.cooldown, expiration = _b.expiration, aborter = _b.aborter, optimistic = _b.optimistic;
     var ready = state !== null;
     var loading = Boolean(aborter);
-    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, update: update, clear: clear };
+    return { key: key, skey: skey, data: data, error: error, time: time, cooldown: cooldown, expiration: expiration, aborter: aborter, optimistic: optimistic, loading: loading, ready: ready, mutate: mutate, fetch: fetch, refetch: refetch, update: update, clear: clear };
 }
 
 function use(factory, deps) {

diff --git a/dist/mods/react/hooks/handles/handle.d.ts b/dist/mods/react/hooks/handles/handle.d.ts
@@ -32,6 +32,11 @@ export interface Handle<D = any, E = any, K = any> {
      * Abort controller, can be used to abort and check for abortion, present when a fetch is ongoing (except those from update())
      */
     aborter?: AbortController;
+    /**
+     * - Whether the data is from an optimistic update
+     * - Whether the ongoing request is an optimistic update
+     */
+    optimistic?: boolean;
     /**
      * Expiration time of this resource, if any, may be useful for fetching just before the resource becomes stale
      */

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hazae41/xswr",
-  "version": "1.0.54",
+  "version": "1.0.55",
   "author": "hazae41",
   "license": "MIT",
   "description": "The simplest React data (re)fetching library ever made",

diff --git a/src/mods/react/hooks/handles/handle.ts b/src/mods/react/hooks/handles/handle.ts
@@ -41,6 +41,12 @@ export interface Handle<D = any, E = any, K = any> {
    */
   aborter?: AbortController,
 
+  /**
+   * - Whether the data is from an optimistic update
+   * - Whether the ongoing request is an optimistic update
+   */
+  optimistic?: boolean,
+
   /**
    * Expiration time of this resource, if any, may be useful for fetching just before the resource becomes stale
    */

diff --git a/src/mods/react/hooks/handles/scroll.ts b/src/mods/react/hooks/handles/scroll.ts
@@ -79,10 +79,10 @@ export function useScroll<D = any, E = any, K = any>(
     await core.delete(skey, mparams)
   }, [core, skey])
 
-  const { data, error, time, cooldown, expiration, aborter } = state ?? {}
+  const { data, error, time, cooldown, expiration, aborter, optimistic } = state ?? {}
 
   const ready = state !== null
   const loading = Boolean(aborter)
 
-  return { key, skey, data, error, time, cooldown, expiration, aborter, loading, ready, mutate, fetch, refetch, scroll, clear }
+  return { key, skey, data, error, time, cooldown, expiration, aborter, optimistic, loading, ready, mutate, fetch, refetch, scroll, clear }
 }
diff --git a/src/mods/react/hooks/handles/single.ts b/src/mods/react/hooks/handles/single.ts
@@ -77,10 +77,10 @@ export function useSingle<D = any, E = any, K = any>(
     await core.delete(skey, mparams)
   }, [core, skey])
 
-  const { data, error, time, cooldown, expiration, aborter } = state ?? {}
+  const { data, error, time, cooldown, expiration, aborter, optimistic } = state ?? {}
 
   const ready = state !== null
   const loading = Boolean(aborter)
 
-  return { key, skey, data, error, time, cooldown, expiration, aborter, loading, ready, mutate, fetch, refetch, update, clear }
+  return { key, skey, data, error, time, cooldown, expiration, aborter, optimistic, loading, ready, mutate, fetch, refetch, update, clear }
 }