docs(persist): fix signature to require persistOptions#3477
Merged
dbritto-dev merged 1 commit intoApr 27, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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. |
dbritto-dev
approved these changes
Apr 27, 2026
Collaborator
|
Thanks for your contribution |
Contributor
Author
Happy to help! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Related Bug Reports or Discussions
Fixes #
Summary
The persist docs showed persistOptions as optional, which is misleading. In practice, persist needs a config object (including a required name), so calling it with only the state creator is not valid.
This PR updates the TypeScript signature and reference heading in the persist docs to clearly show the correct usage: persist(stateCreatorFn, persistOptions).
Ref:
https://github.com/pmndrs/zustand/blob/main/src/middleware/persist.ts#L377-L385
https://github.com/pmndrs/zustand/blob/main/src/middleware/persist.ts#L59-L73
Check List
(docs only change)
pnpm run fixfor formatting and linting code and docs