refactor: rename generateStorage to generateLocalStorage for clarity#255
Open
refactor: rename generateStorage to generateLocalStorage for clarity#255
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR renames the generateStorage function to generateLocalStorage and updates its usage to improve naming clarity and consistency with the existing generateSessionStorage helper.
- Renamed
generateStoragetogenerateLocalStorage - Updated
safeLocalStorageinitialization to use the new function name
Comments suppressed due to low confidence (2)
src/hooks/useStorageState/storage.ts:100
- Renaming
generateStoragetogenerateLocalStorageis a breaking change for any external consumers. Consider adding a deprecated aliasexport const generateStorage = generateLocalStorage;or bumping a major version to signal the API change.
export function generateLocalStorage(): Storage {
src/hooks/useStorageState/storage.ts:100
- Ensure the JSDoc comment above this function is updated to reflect the new name
generateLocalStorageand clearly explain its purpose.
export function generateLocalStorage(): Storage {
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.
Overview
This PR renames the generateStorage function to generateLocalStorage for improved clarity and consistency.
The previous function name did not clearly convey its actual purpose, which is to provide a LocalStorage instance or a memory-based fallback when LocalStorage is unavailable.
By aligning the naming convention with generateSessionStorage, this change enhances code readability and maintainability, and reduces potential confusion for collaborators.
Reason for Change
To make the function's purpose explicit, allowing developers to immediately understand that it returns a LocalStorage (or fallback) instance.
To ensure naming consistency with generateSessionStorage, improving overall codebase coherence.
To reduce ambiguity and improve maintainability during code reviews and future development.
Checklist
yarn test:coverageto make sure there is no uncovered line?