Fix Support for Node and Add Docs for Node and SSR #15
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
- in certain environments like Node, 'window' will not be defined and so will cause mst-persist to error out on its check for localStorge, even if a different storage engine were configured - this fix enables usage in Node environments, supporting usage like hydrating server-side
- if the localStorage default is unsupported in the current
environment (e.g. Node), then it should throw with a specific
error instead of continuing and unexpectedly throwing on getItem
- will still error out, so not a "fix" in that sense, but it now will
throw a better, more understandable error
This was referenced Jul 27, 2019
agilgur5
commented
Jul 27, 2019
agilgur5
commented
Jul 27, 2019
agilgur5
commented
Jul 27, 2019
- redux-persist's Storage Engines all follow the same localForage-style
async Promise API, so they should all be compatible with mst-persist
as well
- docs should mention this as the interoperability adds many more
usage options for developers
- e.g. using node-storage or cookie-storage for Node or universal
apps, which should now work without bugs
- note that one can hydrate server-side with Node and give some example storage engines one may use for that purpose - note that server-side hydartion can be skipped for certain use cases like SSR and give example for how to do so
This was referenced Jul 27, 2019
agilgur5
added
scope: docs
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.
Replaces #6 and #9 and resolves #13
The gotchas in #9 were a bit too confusing for me to really be okay with merging such functionality in. On top of that, once I discovered that
redux-persist's Storage Engines were also compatible withmst-persist(per #13), it meant thatmst-persistcould already support Node environments very easily, so I wouldn't want to hamper that type of usage by making it extremely unintuitive.I think asking developers to put a conditional check in their own source code to handle SSR without server-side hydration is much simpler and less confusing, and therefore likely worthwhile even if it entails a bit more thought & work out-of-the-box.