Add types to range calculation functions #237
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
|
What's your thinking in having it just be those two? |
mhkeller
reviewed
Oct 7, 2024
| * @param {number} width | ||
| * @param {number} height | ||
| * @param {boolean} reverse | ||
| * @param {[number, number]|Function|null} range |
There was a problem hiding this comment.
Instead of function, what if we were more specific and defined the arguments. Something like this?
/*
* @typedef {function} RangeType
* @param {{width: number, height: number}} dimensions - The dimensions object containing width and height.
* @returns {Array<number|string>} The calculated range .
mhkeller
reviewed
Oct 7, 2024
| * @param {number} height | ||
| * @param {boolean} reverse | ||
| * @param {[number, number]|Function|null} range | ||
| * @param {boolean} percentRange |
There was a problem hiding this comment.
We should probably add a return description to the type like in the above comment
Uh, yeah, I got confused in the ternaries handling |
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.
Maybe the
sparameter should only beyorr?