Support options.keyArgs to complement options.makeCacheKey. #65
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
This optional function takes the raw arguments passed to an OptimisticFunctionWrapper and simplifies/filters/reduces them down to an array of arguments sufficient to identify the cache result. This simplified array of arguments is then passed to options.makeCacheKey (or defaultMakeCacheKey if no options.makeCacheKey was provided). The returned array serves as the arguments list for any function that only needs to compute a cache key (and thus does not need the full raw arguments), such as wrapper.dirty and options.makeCacheKey. This makes it possible to dirty a cached function using less information than would be required to call it properly, which is useful in some cases. In some sense, options.keyArgs and options.makeCacheKey divide up the work of computing cache keys from raw arguments. Both functions are optional, and any combination of the two that satisfies the type system is allowed. If the sequence of arguments returned by options.keyArgs can be passed directly to defaultMakeCacheKey, you may not need to define a custom options.makeCacheKey function anymore.
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.
This optional function takes the raw arguments passed to an
OptimisticFunctionWrapperand simplifies/filters/reduces them down to an array of arguments sufficient to identify the cache result. This simplified array of arguments is then passed tooptions.makeCacheKey(ordefaultMakeCacheKeyif nooptions.makeCacheKeywas provided).The resulting array serves as the arguments list for any function that only needs to compute a cache key (and thus does not need the full raw arguments), such as
wrapper.dirtyandoptions.makeCacheKey. This makes it possible todirtya cached function using less information than would be required to call it properly, which is useful in some cases.In some sense,
options.keyArgsandoptions.makeCacheKeydivide up the work of computing cache keys from raw arguments. Both functions are optional, and any combination of the two that satisfies the type system is allowed. If the sequence of arguments returned byoptions.keyArgscan be passed directly todefaultMakeCacheKey, you may not need to define a customoptions.makeCacheKeyfunction anymore.