docs(useStorageState): Clarify serializer and deserializer function types #274
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
useStorageState
hook by explicitly specifying the types of theserializer
anddeserializer
functions in the options parameter.By defining
serializer
as(value: Serializable<T>) => string
anddeserializer
as(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 fix
to format and lint the code and docs?yarn run test:coverage
to make sure there is no uncovered line?