Improve HTMLCanvasElement and OffscreenCanvas types #52851
Closed
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
I changed `HTMLCanvasElement.getContext` to follow the pattern set by `OffscreenCanvas` where the context ID is a string union so we get autocompletion for it in IDEs using LSP. In the other direction, I changed `OffscreenCanvas.getContext` to follow `HTMLCanvasElement`'s pattern with overloads for the individual context IDs as literal string parameters and return types being the specific types of context corresponding to that context ID. I have also added `OffscreenCanvas.convertToBlob` which was missing altogether: https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas/convertToBlob
Collaborator
|
It looks like you've sent a pull request to update our 'lib' files. These files aren't meant to be edited by hand, as they consist of last-known good states of the compiler and are generated from 'src/lib' or possibly our lib generator. Unless this is necessary, consider closing the pull request and sending a separate PR to update 'src/lib' or https://github.com/microsoft/TypeScript-DOM-lib-generator |
Collaborator
|
It looks like you've sent a pull request to update some generated declaration files related to the DOM. These files aren't meant to be edited by hand, as they are synchronized with files in the TSJS-lib-generator repository. You can read more here. For house-keeping purposes, this pull request will be closed. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
I changed
HTMLCanvasElement.getContextto follow the pattern set byOffscreenCanvaswhere the context ID is a string union so we get autocompletion for it in IDEs using LSP.In the other direction, I changed
OffscreenCanvas.getContextto followHTMLCanvasElement's pattern with overloads for the individual context IDs as literal string parameters and return types being the specific types of context corresponding to that context ID.I have also added
OffscreenCanvas.convertToBlobwhich was missing altogether: https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas/convertToBlobPlease verify that:
Backlogmilestone (required):lib.dom.d.tsOffscreenCanvas.getContext() not returning type based on context ID #52831mainbranchhereby runtestslocallyFixes #52831