fix(docs): Do not recommend deprecated useStore + equalityFn on initialize with props docs #1997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
michelts
changed the title
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 51af424:
|
dai-shi
reviewed
Aug 16, 2023
I agree, and I'd say that most people don't use |
|
Sure! I updated the content, how does it sound? |
sewera
approved these changes
Aug 16, 2023
Co-authored-by: Blazej Sewera <code@sewera.dev>
dai-shi
approved these changes
Aug 16, 2023
|
Done! Sorry not noticing it earlier. |
dai-shi
changed the title
bodinsamuel
referenced
this pull request
in specfy/specfy
Nov 8, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [zustand](https://github.com/pmndrs/zustand) | [`4.4.1` -> `4.4.6`](https://renovatebot.com/diffs/npm/zustand/4.4.1/4.4.6) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pmndrs/zustand (zustand)</summary> ### [`v4.4.6`](https://github.com/pmndrs/zustand/releases/tag/v4.4.6) [Compare Source](https://github.com/pmndrs/zustand/compare/v4.4.5...v4.4.6) v4.4.5 has an issue with some TypeScript configs about module resolution. It should be fixed now. Thanks for the patience. #### What's Changed - Update export types by [@​dbritto-dev](https://github.com/dbritto-dev) in [https://github.com/pmndrs/zustand/pull/2170](https://github.com/pmndrs/zustand/pull/2170) #### New Contributors - [@​cheatkey](https://github.com/cheatkey) made their first contribution in [https://github.com/pmndrs/zustand/pull/2147](https://github.com/pmndrs/zustand/pull/2147) - [@​frixaco](https://github.com/frixaco) made their first contribution in [https://github.com/pmndrs/zustand/pull/2166](https://github.com/pmndrs/zustand/pull/2166) **Full Changelog**: pmndrs/zustand@v4.4.5...v4.4.6 ### [`v4.4.5`](https://github.com/pmndrs/zustand/releases/tag/v4.4.5) [Compare Source](https://github.com/pmndrs/zustand/compare/v4.4.4...v4.4.5) Hopefully, it should fix some issues with Node.js environment including Next.js. #### What's Changed - fix: importing CJS React in ESM by [@​dai-shi](https://github.com/dai-shi) in [https://github.com/pmndrs/zustand/pull/2154](https://github.com/pmndrs/zustand/pull/2154) - Apply publint recommendations by [@​dbritto-dev](https://github.com/dbritto-dev) in [https://github.com/pmndrs/zustand/pull/2157](https://github.com/pmndrs/zustand/pull/2157) #### New Contributors - [@​plrs9816](https://github.com/plrs9816) made their first contribution in [https://github.com/pmndrs/zustand/pull/2137](https://github.com/pmndrs/zustand/pull/2137) - [@​Brammm](https://github.com/Brammm) made their first contribution in [https://github.com/pmndrs/zustand/pull/2139](https://github.com/pmndrs/zustand/pull/2139) - [@​sobies93](https://github.com/sobies93) made their first contribution in [https://github.com/pmndrs/zustand/pull/2142](https://github.com/pmndrs/zustand/pull/2142) **Full Changelog**: pmndrs/zustand@v4.4.4...v4.4.5 ### [`v4.4.4`](https://github.com/pmndrs/zustand/releases/tag/v4.4.4) [Compare Source](https://github.com/pmndrs/zustand/compare/v4.4.3...v4.4.4) There was a tiny issue in v4.4.3, which broke with some bundlers, which this version fixes. #### What's Changed - fix(build): patch entry points zustand/shallow for CJS by [@​dai-shi](https://github.com/dai-shi) in [https://github.com/pmndrs/zustand/pull/2128](https://github.com/pmndrs/zustand/pull/2128) **Full Changelog**: pmndrs/zustand@v4.4.3...v4.4.4 ### [`v4.4.3`](https://github.com/pmndrs/zustand/releases/tag/v4.4.3) [Compare Source](https://github.com/pmndrs/zustand/compare/v4.4.2...v4.4.3) The changes in v4.4.2 were troublesome for some users. This version should fix/mitigate such cases. #### What's Changed - fix(shallow): Extract shallow vanilla and react by [@​dbritto-dev](https://github.com/dbritto-dev) in [https://github.com/pmndrs/zustand/pull/2097](https://github.com/pmndrs/zustand/pull/2097) - fix(types): mitigate devtools typing by [@​dai-shi](https://github.com/dai-shi) in [https://github.com/pmndrs/zustand/pull/2099](https://github.com/pmndrs/zustand/pull/2099) **Full Changelog**: pmndrs/zustand@v4.4.2...v4.4.3 ### [`v4.4.2`](https://github.com/pmndrs/zustand/releases/tag/v4.4.2) [Compare Source](https://github.com/pmndrs/zustand/compare/v4.4.1...v4.4.2) This adds `useShallow` hook to cover some use cases that are deprecated with v4.4.0 change. Check out [the guide](https://github.com/pmndrs/zustand/blob/ec538e9d4c0b9b5759e6dfd0fd3c9a21f8236949/docs/guides/prevent-rerenders-with-use-shallow.md). ##### Migration Guide [#​1991](https://github.com/pmndrs/zustand/issues/1991) requires something like below if you are using the `devtools` middleware *and* TypeScript. ```diff import { devtools } from 'zustand/middleware' + import type {} from '@​redux-devtools/extension' ``` ##### What's Changed - fix(types)(middleware/devtools): avoid copying types by [@​dai-shi](https://github.com/dai-shi) in [https://github.com/pmndrs/zustand/pull/1991](https://github.com/pmndrs/zustand/pull/1991) - fix(traditional): make defaultEqualityFn optional in TS Types by [@​charkour](https://github.com/charkour) in [https://github.com/pmndrs/zustand/pull/2060](https://github.com/pmndrs/zustand/pull/2060) - feat: add useShallow by [@​FaberVitale](https://github.com/FaberVitale) in [https://github.com/pmndrs/zustand/pull/2090](https://github.com/pmndrs/zustand/pull/2090) ##### New Contributors - [@​aykutkardas](https://github.com/aykutkardas) made their first contribution in [https://github.com/pmndrs/zustand/pull/1993](https://github.com/pmndrs/zustand/pull/1993) - [@​michelts](https://github.com/michelts) made their first contribution in [https://github.com/pmndrs/zustand/pull/1997](https://github.com/pmndrs/zustand/pull/1997) - [@​elusive](https://github.com/elusive) made their first contribution in [https://github.com/pmndrs/zustand/pull/2001](https://github.com/pmndrs/zustand/pull/2001) - [@​mayank1513](https://github.com/mayank1513) made their first contribution in [https://github.com/pmndrs/zustand/pull/2015](https://github.com/pmndrs/zustand/pull/2015) - [@​fdb](https://github.com/fdb) made their first contribution in [https://github.com/pmndrs/zustand/pull/2029](https://github.com/pmndrs/zustand/pull/2029) - [@​tmkx](https://github.com/tmkx) made their first contribution in [https://github.com/pmndrs/zustand/pull/2032](https://github.com/pmndrs/zustand/pull/2032) - [@​OshriAsulin](https://github.com/OshriAsulin) made their first contribution in [https://github.com/pmndrs/zustand/pull/2028](https://github.com/pmndrs/zustand/pull/2028) - [@​ivanquirino](https://github.com/ivanquirino) made their first contribution in [https://github.com/pmndrs/zustand/pull/2047](https://github.com/pmndrs/zustand/pull/2047) - [@​stavkamil](https://github.com/stavkamil) made their first contribution in [https://github.com/pmndrs/zustand/pull/2071](https://github.com/pmndrs/zustand/pull/2071) - [@​NaamuKim](https://github.com/NaamuKim) made their first contribution in [https://github.com/pmndrs/zustand/pull/2088](https://github.com/pmndrs/zustand/pull/2088) - [@​FaberVitale](https://github.com/FaberVitale) made their first contribution in [https://github.com/pmndrs/zustand/pull/2090](https://github.com/pmndrs/zustand/pull/2090) **Full Changelog**: pmndrs/zustand@v4.4.1...v4.4.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 4pm every weekday" in timezone Europe/Paris, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/specfy/specfy). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6ImNob3JlL3Jlbm92YXRlQmFzZUJyYW5jaCJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Passing an equalityFn to the useStore hook is deprecated. The documentation to initialize the store from props is recommending the approach. It was updated to recommend using useStoreWithEqualityFn instead.
Check List
yarn run prettierfor formatting code and docsBTW notice running prettier messed with a lot of files but didn't change the file I changed. I'm not pushing those other files formatting changes though.