Skip to content

Add @deprecated reasons in lib.dom.d.ts #39514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mjbvz opened this issue Jul 9, 2020 · 1 comment · Fixed by microsoft/TypeScript-DOM-lib-generator#884
Closed

Add @deprecated reasons in lib.dom.d.ts #39514

mjbvz opened this issue Jul 9, 2020 · 1 comment · Fixed by microsoft/TypeScript-DOM-lib-generator#884
Labels
Bug A bug in TypeScript Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Rescheduled This issue was previously scheduled to an earlier milestone

Comments

@mjbvz
Copy link
Contributor

mjbvz commented Jul 9, 2020

TypeScript Version: 4.0.0-beta

Search Terms

  • @deprecated
  • dom
  • d.ts

Problem

With TypeScript 4.0, we now render use of @deprecated apis. The dom apis include many deprecated symbols, but some of these do not include a reason that explains why a given api is deprecated and which API to use instead. This can be frustrating for users who don't want to see a strike through in the code but also don't know how to fix the problem

Proposal

Where possible, add @deprecated messages to the dom apis. See the MDN documentation on the deprecated ScriptProcessorNode for example: https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode

/cc @DanielRosenwasser

@RyanCavanaugh RyanCavanaugh added the Bug A bug in TypeScript label Jul 9, 2020
@RyanCavanaugh RyanCavanaugh added this to the TypeScript 4.1 milestone Jul 9, 2020
@RyanCavanaugh
Copy link
Member

I'm not sure how many of these there are, but it'd be nice to have a list to check off

@RyanCavanaugh RyanCavanaugh added the Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript label Jul 9, 2020
@RyanCavanaugh RyanCavanaugh added the Rescheduled This issue was previously scheduled to an earlier milestone label Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug in TypeScript Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Rescheduled This issue was previously scheduled to an earlier milestone
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants