Improve types to reflect key-making functions may return undefined
#627
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
benjamn
commented
Nov 29, 2023
Comment on lines
87
to
+91
| // This property is equivalent to the makeCacheKey function provided in the | ||
| // OptimisticWrapOptions, or (if no options.makeCacheKey function is provided) | ||
| // a default implementation of makeCacheKey. | ||
| makeCacheKey: (...args: TKeyArgs) => TCacheKey; | ||
| // a default implementation of makeCacheKey. This function is also exposed as | ||
| // optimistic.options.makeCacheKey, somewhat redundantly. | ||
| makeCacheKey: (...args: TKeyArgs) => TCacheKey | undefined; |
There was a problem hiding this comment.
I think this optimistic.makeCacheKey function could/should be removed in v1.0, since it's redundant with optimistic.options.makeCacheKey, but I didn't want any breaking changes in this PR.
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.
Returning undefined from
makeCacheKeyis the recommended technique for efficiently opting out of caching for particular combinations of input arguments, so that possibility should be reflected in the TypeScript types for the various functions that handle keys.