-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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.
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
docs: update documentation of persist #2147
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8fdfe3a
docs: update documentation of persist
cheatkey 0bb6035
docs: fix spelling documentation of persist
cheatkey 84f202d
docs: Apply feedback by moving content under custom storage engine an…
cheatkey eb37b28
docs: Update variable name to example name and separate storage as const
cheatkey File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -731,3 +731,31 @@ interface BearState { | |
removeItem: (name) => localStorage.removeItem(name), | ||
}, | ||
``` | ||
|
||
If writing serialization and deserialization code is tedious, you can use third-party libraries to serialize and deserialize different types of data | ||
|
||
SuperJSON serialize data along with its type, allowing the data to be parsed back to its original type upon deserialization | ||
|
||
```ts | ||
import superjson from "superjson"; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please run prettier. |
||
import { StorageValue } from "zustand/middleware"; | ||
|
||
interface BearState { | ||
// ... | ||
} | ||
//... | ||
|
||
storage: { | ||
getItem: (name) => { | ||
const str = localStorage.getItem(name); | ||
if (!str) return null; | ||
return { | ||
state: superjson.parse<StorageValue<BearState>>(str).state, | ||
}; | ||
}, | ||
setItem: (name, value) => { | ||
localStorage.setItem(name, superjson.stringify(value)); | ||
}, | ||
removeItem: (name) => localStorage.removeItem(name), | ||
} | ||
``` |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, how about adding this?