Skip to content
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

Jump to bottom

fix: improve warning for deprecated equalityFn #1976

Merged
merged 3 commits into from Aug 6, 2023
Merged

fix: improve warning for deprecated equalityFn #1976

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64752a2
fix: improve warning for deprecated equalityFn
dai-shi Aug 5, 2023
ff33e84
fix tsc error
dai-shi Aug 5, 2023
439a73b
Merge branch 'main' into fix/deprecation-warning
dai-shi Aug 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/react.ts
View file
Open in desktop
Expand Up @@ -23,6 +23,8 @@ type WithReact<S extends ReadonlyStoreApi<unknown>> = S & {
getServerState?: () => ExtractState<S>
}

let didWarnAboutEqualityFn = false

export function useStore<S extends WithReact<StoreApi<unknown>>>(
api: S
): ExtractState<S>
Expand All @@ -47,10 +49,15 @@ export function useStore<TState, StateSlice>(
selector: (state: TState) => StateSlice = api.getState as any,
equalityFn?: (a: StateSlice, b: StateSlice) => boolean
) {
if (import.meta.env?.MODE !== 'production' && equalityFn) {
if (
import.meta.env?.MODE !== 'production' &&
equalityFn &&
!didWarnAboutEqualityFn
) {
console.warn(
"[DEPRECATED] Use `createWithEqualityFn` from 'zustand/traditional'. https://github.com/pmndrs/zustand/discussions/1937"
"[DEPRECATED] Use `createWithEqualityFn` instead of `create` or use `useStoreWithEqualityFn` instead of `useStore`. They can be imported from 'zustand/traditional'. https://github.com/pmndrs/zustand/discussions/1937"
)
didWarnAboutEqualityFn = true
}
Comment on lines -50 to 61
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be a good idea to extract this to equalityFn && warnAboutEqualityFnOnce()

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, that doesn't work with minification/dead-code-elimination in production.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, I don't have any more suggestions then.

const slice = useSyncExternalStoreWithSelector(
api.subscribe,
Expand Down