You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The v2.0.0 Quick Start Guide contains a couple of discrepancies and missing details that could lead to confusion for users. Here are the issues I encountered:
1. import { stateSyncEnhancer } from 'electron-redux' does not work
It appears that stateSyncEnhancer is not exported from the top-level electron-redux module. Instead, it is exported from either electron-redux/renderer or electron-redux/main.
To make it work, I had to adjust the import paths as follows:
// For the renderer processimport{stateSyncEnhancer}from'electron-redux/renderer'// For the main processimport{stateSyncEnhancer}from'electron-redux/main'
It might be helpful to clarify the documentation or update the package exports to align with the Quick Start guide. If this is a misunderstanding on my part, I apologize in advance.
2. 'electron-redux/preload' is not mentioned as required
To use electron-redux correctly, it seems necessary to import 'electron-redux/preload' in the preload script.
This important step is not mentioned in the Quick Start Guide. As a result, users following the guide might encounter errors, as I did. Including this requirement in the guide would help prevent such issues.
Thank you for your attention to these points!
I hope this feedback is helpful in improving the documentation for future users.
The text was updated successfully, but these errors were encountered:
The v2.0.0 Quick Start Guide contains a couple of discrepancies and missing details that could lead to confusion for users. Here are the issues I encountered:
1.
import { stateSyncEnhancer } from 'electron-redux'
does not workThe Quick Start guide for v2.0.0 suggests using the following import:
However, this import does not seem to work.
It appears that
stateSyncEnhancer
is not exported from the top-levelelectron-redux
module. Instead, it is exported from eitherelectron-redux/renderer
orelectron-redux/main
.To make it work, I had to adjust the import paths as follows:
It might be helpful to clarify the documentation or update the package exports to align with the Quick Start guide. If this is a misunderstanding on my part, I apologize in advance.
2. 'electron-redux/preload' is not mentioned as required
To use electron-redux correctly, it seems necessary to import 'electron-redux/preload' in the preload script.
This important step is not mentioned in the Quick Start Guide. As a result, users following the guide might encounter errors, as I did. Including this requirement in the guide would help prevent such issues.
Thank you for your attention to these points!
I hope this feedback is helpful in improving the documentation for future users.
The text was updated successfully, but these errors were encountered: