updaters now yield results instead of states, added realData

dist/mods/react/hooks/handles/handle.d.ts

@@ -13,6 +13,10 @@ export interface Handle<D = any, E = any, K = any> {
      * Data, if any
      */
     data?: D;
+    /**
+     * Data, if any, but not optimistic
+     */
+    realData?: D;
     /**
      * Error, if any
      */

dist/mods/types/state.d.ts

@@ -6,4 +6,5 @@ export interface State<D = any, E = any, K = any> {
     optimistic?: boolean;
     cooldown?: number;
     expiration?: number;
+    realData?: D;
 }

dist/mods/types/updater.d.ts

@@ -1,5 +1,6 @@
+import { Result } from "./result";
 import { State } from "./state";
-export declare type Updater<D = any, E = any, K = any> = (previous: State<D, E, K> | undefined, more: UpdaterMore<D, E, K>) => AsyncGenerator<State<D, E, K>, State<D, E, K> | void>;
+export declare type Updater<D = any, E = any, K = any> = (previous: State<D, E, K> | undefined, more: UpdaterMore<D, E, K>) => AsyncGenerator<Result<D, E, K>, Result<D, E, K> | void>;
 export interface UpdaterMore<D = any, E = any, K = any> {
     signal?: AbortSignal;
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hazae41/xswr",
-  "version": "1.0.85",
+  "version": "1.0.86",
   "author": "hazae41",
   "license": "MIT",
   "description": "The simplest React data (re)fetching library ever made",

src/mods/core.ts

@@ -144,24 +144,26 @@ export class Core extends Ortho<string, State | undefined> {
     if (state.optimistic === undefined && current?.optimistic)
       return current
 
+    const {
+      equals = DEFAULT_EQUALS
+    } = params
+
     const next: State<D, E, K> = {
       ...current,
       ...state
     }
 
-    if (next.time === undefined)
-      next.time = Date.now()
     next.data = await this.normalize(false, next, params)
 
-    const {
-      equals = DEFAULT_EQUALS
-    } = params
-
-    if (equals(next.data, current?.data)) // Prevent some renders if the data is the same
+    if (next.time === undefined)
+      next.time = Date.now()
+    if (equals(next.data, current?.data))
       next.data = current?.data
-    if (shallowEquals(next, current)) // Shallow comparison because aborter is not serializable
-      return current
+    if (!next.optimistic)
+      next.realData = next.data
 
+    if (shallowEquals(next, current))
+      return current
     await this.set(skey, next, params)
     return next as State<D, E, K>
   }

src/mods/react/hooks/handles/handle.ts

@@ -17,6 +17,11 @@ export interface Handle<D = any, E = any, K = any> {
    */
   data?: D
 
+  /**
+   * Data, if any, but not optimistic
+   */
+  realData?: D
+
   /**
    * Error, if any
    */

src/mods/react/hooks/handles/scroll.ts

@@ -170,10 +170,10 @@ export function useScroll<D = any, E = any, K = any>(
 
   const state = stateRef.current
 
-  const { data, error, time, cooldown, expiration, aborter, optimistic } = state ?? {}
+  const { data, error, time, cooldown, expiration, aborter, optimistic, realData } = state ?? {}
 
   const ready = state !== null
   const loading = Boolean(aborter)
 
-  return { key, skey, data, error, time, cooldown, expiration, aborter, optimistic, loading, ready, mutate, fetch, refetch, scroll, clear, suspend }
+  return { key, skey, data, error, time, cooldown, expiration, aborter, optimistic, realData, loading, ready, mutate, fetch, refetch, scroll, clear, suspend }
 }

src/mods/react/hooks/handles/single.ts

@@ -168,10 +168,10 @@ export function useSingle<D = any, E = any, K = any>(
 
   const state = stateRef.current
 
-  const { data, error, time, cooldown, expiration, aborter, optimistic } = state ?? {}
+  const { data, error, time, cooldown, expiration, aborter, optimistic, realData } = state ?? {}
 
   const ready = state !== null
   const loading = Boolean(aborter)
 
-  return { key, skey, data, error, time, cooldown, expiration, aborter, optimistic, loading, ready, mutate, fetch, refetch, update, clear, suspend }
+  return { key, skey, data, error, time, cooldown, expiration, aborter, optimistic, realData, loading, ready, mutate, fetch, refetch, update, clear, suspend }
 }

src/mods/types/state.ts

@@ -5,5 +5,6 @@ export interface State<D = any, E = any, K = any> {
   aborter?: AbortController,
   optimistic?: boolean,
   cooldown?: number
-  expiration?: number
+  expiration?: number,
+  realData?: D
 }

src/mods/types/updater.ts

@@ -1,7 +1,8 @@
+import { Result } from "./result"
 import { State } from "./state"
 
 export type Updater<D = any, E = any, K = any> =
-  (previous: State<D, E, K> | undefined, more: UpdaterMore<D, E, K>) => AsyncGenerator<State<D, E, K>, State<D, E, K> | void>
+  (previous: State<D, E, K> | undefined, more: UpdaterMore<D, E, K>) => AsyncGenerator<Result<D, E, K>, Result<D, E, K> | void>
 
 export interface UpdaterMore<D = any, E = any, K = any> {
   signal?: AbortSignal

test/next/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "@hazae41/xswr": "^1.0.85",
+    "@hazae41/xswr": "^1.0.86",
     "next": "12.2.5",
     "react": "18.2.0",
     "react-dom": "18.2.0"

test/next/pages/optimistic/index.tsx

@@ -21,7 +21,7 @@ export default function Page() {
   const hello = useHelloData()
 
   // this is for you, gaearon
-  const { data, error, time, loading, update, refetch, mutate, aborter, optimistic } = hello
+  const { data, realData, error, time, loading, update, refetch, mutate, aborter, optimistic } = hello
 
   const onRefreshClick = useCallback(() => {
     refetch()
@@ -50,7 +50,10 @@ export default function Page() {
 
   return <>
     <div>
-      {JSON.stringify(data) ?? "undefined"}
+      Data: {JSON.stringify(data) ?? "undefined"}
+    </div>
+    <div>
+      Real data: {JSON.stringify(realData) ?? "undefined"}
     </div>
     <div>
       time: {time && ~~(time / 1000)}