Add isOnUnmount to onSave callback #31
Open
Conversation
This file contains 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
jollyjerr
reviewed
Feb 3, 2024
| @@ -4,7 +4,7 @@ export interface CommonProps<TData, TReturn> { | |||
| /** The controlled form value to be auto saved */ | |||
| data: TData; | |||
| /** Callback function to save your data */ | |||
| onSave: (data: TData) => Promise<TReturn> | TReturn | void; | |||
| onSave: (data: TData, isOnUnmount: boolean) => Promise<TReturn> | TReturn | void; | |||
There was a problem hiding this comment.
Suggested change
| onSave: (data: TData, isOnUnmount: boolean) => Promise<TReturn> | TReturn | void; | |
| onSave: (data: TData, meta: {unmounting: boolean}) => Promise<TReturn> | TReturn | void; |
Could we wrap this in an object so if we ever need to add more metadata it is not a breaking change to the callback's contract?
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.
Hello there!
I'm currently using this library for autosave, and I must say I appreciate its simplicity. However, I've encountered a specific use case that the library doesn't quite address. I perform a request in each onSave, but I'd prefer not to invalidate my cache in every request, I prefer to do only when the component unmount. As of now, I can achieve this by creating a separate useEffect just for that purpose or implementing it the existing onSave callback.
I'm curious to know if you've considered implementing a feature in the library. It would be great if the library could provide an option to know if is an onmount callback or not.
What are your thoughts on this idea?