You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/reference/react/useSyncExternalStore.md
+31-5Lines changed: 31 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -377,18 +377,18 @@ Make sure that `getServerSnapshot` returns the same exact data on the initial cl
377
377
378
378
This error means your `getSnapshot` function returns a new object every time it's called, for example:
379
379
380
-
```js {2-5}
380
+
```js {3-5}
381
381
functiongetSnapshot() {
382
-
// 🔴 Do not return always different objects from getSnapshot
382
+
// 🔴 This creates a new object every time getSnapshot is called, even when myStore.todos has not changed
383
383
return {
384
384
todos:myStore.todos
385
385
};
386
386
}
387
387
```
388
388
389
-
React will re-render the component if `getSnapshot`return value is different from the last time. This is why, if you always return a different value, you will enter an infinite loop and get this error.
389
+
React will re-render the component if `getSnapshot`returns a different object than the last time it was called. Therefore, if you create a new object, React will enter an infinite loop and raise this error.
390
390
391
-
Your `getSnapshot` object should only return a different object if something has actually changed. If your store contains immutable data, you can return that data directly:
391
+
Your `getSnapshot` object should only return a different object if the data in the external store has actually changed. If your store contains immutable data, you can return that data directly:
392
392
393
393
```js {2-3}
394
394
functiongetSnapshot() {
@@ -397,7 +397,33 @@ function getSnapshot() {
397
397
}
398
398
```
399
399
400
-
If your store data is mutable, your `getSnapshot` function should return an immutable snapshot of it. This means it *does* need to create new objects, but it shouldn't do this for every single call. Instead, it should store the last calculated snapshot, and return the same snapshot as the last time if the data in the store has not changed. How you determine whether mutable data has changed depends on your mutable store.
400
+
If the data in your store is mutable, your `getSnapshot` function should return an immutable snapshot of it. This means it *does* need to create new objects, but it shouldn't do this for every single call. Instead, it should cache the last calculated snapshot, and return a new object only if the data in the store has changed. If it has not changed, you should return the cached object. How you determine whether the data in your store has changed is specific to the store you're using.
401
+
402
+
<DeepDive>
403
+
404
+
#### Why does React re-render even if the values of your object have not changed? {/*a*/}
405
+
406
+
JavaScript has a syntax called [object literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer), which are key-value pairs enclosed in curly braces (`{}`). This syntax creates a new object.
407
+
408
+
However, when comparing objects, JavaScript only checks if the two objects are the same object, not if their *contents* are equal. Because the object literal syntax creates a new object, comparing two objects created with the object literal syntax always gives `false`, even when the values are the same. For example:
409
+
410
+
```js
411
+
object1 = {
412
+
name:"John",
413
+
favoriteNumber:42
414
+
};
415
+
416
+
object2 = {
417
+
name:"John",
418
+
favoriteNumber:42
419
+
};
420
+
421
+
console.log(object1 == object2); // false
422
+
```
423
+
424
+
This means that if your `getSnapshot` function returns a new object (like the first example above did), React will always think the object has changed, and will re-render the component.
0 commit comments