Update jsdoc for PropertyEffects.splice #5367
Merged
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
Array.prototype.splice has its "deleteCount" parameter optional. When omitted, all items of the arrays are removed. This works with a polymer element "splice" method, but the typing does not correspond and TypeScript prevents it. Fixes Polymer#5366
floribon
requested review from
dfreedm,
kevinpschaaf,
sorvell and
TimvdLippe
as code owners
TimvdLippe
approved these changes
Oct 5, 2018
There was a problem hiding this comment.
The tests were added in #5051, so I think that is still okay. Given that the docs already mention it has the same semantics as Array.prototype.splice, I think that is fine as well.
Feel free to backport to 2.x if necessary.
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.
Array.prototype.splice has its "deleteCount" parameter optional. When omitted, all
items of the arrays are removed. This works with a polymer element
"splice" method, but the typing does not correspond and TypeScript
prevents it.
Please let me know if I should:
extend the jsdoc definition of the deleteCount param to specify that
when omitted all items are removed (I assumed that the comment "The
arguments after
pathand return value match that of "Array.prototype.slice" was enough)add a test for the case elem.splice('array', 0). I assumed that this
may end up testing the Array API and not useful
make the same change for the 2.x branch and/or anywhere else
Reference Issue
Fixes #5366