Mark canvasContext as optional
#20149
Merged
Conversation
This file contains hidden or 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
In mozilla#20016, the `canvasContext` property of `RenderParameters` was deprecated in favor of the new `canvas` property. The JSDoc was updated to include the new parameter along with the old one. I think the old one should be enclosed in `[]` to mark it as optional (and to allow usage from TypeScript with just the `canvas` parameter provided). I also reordered the properties so that all required properties come first, follow by optional ones.
|
Does JSDoc support marking things as depretacted? |
Not for individual |
nicolo-ribaudo
approved these changes
Aug 6, 2025
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.
In #20016, the
canvasContextproperty ofRenderParameterswas deprecated in favor of the newcanvasproperty.The JSDoc was updated to include the new parameter along with the old one.
I think the old one should be enclosed in
[]to mark it as optional (and to allow usage from TypeScript with just thecanvasparameter provided).I also reordered the properties so that all required properties come first, follow by optional ones.