feat: add generic localStorage preference helpers (#458)#468
Merged
Chucks1093 merged 1 commit intoJun 26, 2026
Merged
Conversation
|
@Kaycee276 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
4 tasks
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
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.
Description
Closes #458
This PR introduces a central
localStorageutility for managing user preferences (e.g., preserving creator list sort orders across page reloads). The goal is to provide a unified, strictly-typed interface for reading and writing user preferences, eliminating the need for rawlocalStorageboilerplate scattered across components.These shared helpers handle JSON serialization and deserialization seamlessly under the hood. They also ensure robustness by catching potential errors—such as malformed JSON payloads or restricted storage environments—and safely failing back to a provided default value instead of throwing runtime errors.
Changes Made
getPreference<T>andsetPreference<T>utility functions insrc/utils/preferences.utils.tssrc/utils/__tests__/preferences.utils.test.tsto ensure edge cases are fully covered.Verification
The following acceptance criteria have been fully verified via unit tests:
getPreferencecorrectly returns the stored value for a key that exists.getPreferencegracefully returns the default value if the key is missing.getPreferencesafely interceptsJSON.parseerrors from malformed data and returns the default value without crashing.setPreferenceandgetPreferencecan successfully round-trip complex JSON objects.All tests validate locally via
pnpm test src/utils/__tests__/preferences.utils.test.ts.