Skip to content

fix(react): use Object.is instead of === in defaultCompare #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alex-js-ltd wants to merge 7 commits into
base: main
Choose a base branch
from
+9 −2
Open

fix(react): use Object.is instead of === in defaultCompare #298

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
65c1550
fix: use Object.is instead of === in defaultCompare
alex-js-ltd Mar 22, 2026
7dd6c25
chore: add changeset
alex-js-ltd Mar 22, 2026
adfc38d
docs: add JSDoc to defaultCompare
alex-js-ltd Mar 22, 2026
d49f2e8
Merge branch 'main' into fix/default-compare-object-is
KevinVandy Mar 25, 2026
bded194
ci: apply automated fixes and generate docs
autofix-ci[bot] Mar 25, 2026
10ccf35
chore(ci): grant issues write permission to allow commenting
alex-js-ltd Mar 25, 2026
7dd256c
Merge branch 'main' into fix/default-compare-object-is
alex-js-ltd Mar 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/chatty-humans-unite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/react-store': patch
---

fix(react): use Object.is instead of === in defaultCompare to correctly handle NaN and -0 edge cases
1 change: 1 addition & 0 deletions .github/workflows/pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ env:
permissions:
contents: read
pull-requests: write
issues: write

jobs:
test:
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/reference/functions/useStore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function useStore<TAtom, T>(
compare): T;
```

Defined in: [useStore.ts:13](https://github.com/TanStack/store/blob/main/packages/react-store/src/useStore.ts#L13)
Defined in: [useStore.ts:14](https://github.com/TanStack/store/blob/main/packages/react-store/src/useStore.ts#L14)

## Type Parameters

Expand Down
3 changes: 2 additions & 1 deletion packages/react-store/src/useStore.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ type SyncExternalStoreSubscribe = Parameters<
typeof useSyncExternalStoreWithSelector
>[0]

/** Comparator using Object.is to correctly handle NaN and -0 edge cases. */
function defaultCompare<T>(a: T, b: T) {
return a === b
return Object.is(a, b)
}

export function useStore<TAtom extends AnyAtom | undefined, T>(
Expand Down