docs(useStorageState): Clarify serializer and deserializer function types#274
Open
docs(useStorageState): Clarify serializer and deserializer function types#274
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the useStorageState hook by adding explicit type annotations for the serializer and deserializer function parameters, replacing generic "Function" types with specific function signatures that show input and output types.
- Updated JSDoc comments in TypeScript source to include explicit function signatures
- Updated documentation files to show precise function types instead of generic "Function"
- Added generic type parameter
<T>to Korean documentation interface example
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/hooks/useStorageState/useStorageState.ts | Updated JSDoc comments to specify serializer/deserializer function types |
| src/hooks/useStorageState/useStorageState.md | Updated documentation to show explicit function signatures for serializer/deserializer |
| src/hooks/useStorageState/ko/useStorageState.md | Updated Korean documentation with function signatures and added generic type parameter |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #274 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 37 37
Lines 1093 1093
Branches 324 324
=========================================
Hits 1093 1093 🚀 New features to boost your workflow:
|
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 improves the documentation of the
useStorageStatehook by explicitly specifying the types of theserializeranddeserializerfunctions in the options parameter.By defining
serializeras(value: Serializable<T>) => stringanddeserializeras(value: string) => Serializable<T>, users can better understand the expected input and output types, enhancing code safety and usability.This clarification helps users implement custom serialization logic correctly and improves the overall DX.
Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?