fix(BaseManager): properly type valueOf #4594
Merged
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.
Please describe the changes this PR makes and why it should be merged:
BaseManager#valueOf returns its cache collection, but the return is currently typed as
:Object
. This PR documents types the return value based on key and holdings.Further considerations:
Whether or not valueOf should even return a Collection in the first place is another topic, which should be discussed for the next semver major. This is (according to @monbrey) the case due to Util#toJSON expecting to find Collections there to extract the appropriate data for use cases like broadcast evaluations.
Status
Semantic versioning classification: