Is it possible to mark something as deprecated in typescript?

Question

I'm writing typescript definitions for a Javascript API with a deprecated method. Here's an extract of the documentation (they say API but it's just about this single method):

This API has no effect. It has been maintained for compatibility purpose.

For compatibility purposes, I would also like to document this method in the definitions file. But if possible, I would like to communicate somehow, that it has been deprecated.

While my current issue is only about deprecation in a definitions file, I would also like to use this feature in other code. So the question is more general: How can I mark something as deprecated in typescript?

Take a look at https://github.com/microsoft/TypeScript/issues/390 — Kexus, Mar 19 '20 at 12:32

score 372 · Accepted Answer · answered Jul 20 '20 at 08:40

372

You can use JSDoc comments to mark deprecated code:

/**
 * @deprecated The method should not be used
 */
export const oldFunc = () => {}

Also, this eslint rule can look through the deprecated methods and warn about their usage.

answered Jul 20 '20 at 08:40

Vladyslav Zavalykhatko

15,202
8
65
100

26

FYI, VSCode has support for this `@deprecated` JSDoc tag as of v1.49 https://code.visualstudio.com/updates/v1_49#_deprecated-tag-support-for-javascript-and-typescript – DLight Sep 28 '20 at 10:27
4

Do you know how can this be used for values of union types? – mr5 Apr 21 '22 at 12:59
It works, but only at the Editor level. What I need is a warning issued in the compilation messages. – Daniel Lobo Dec 14 '22 at 11:23
1

@DanielLobo If you have eslint set up, you will get a warning/error, depending on the configuration – Vladyslav Zavalykhatko Dec 14 '22 at 16:51

Is it possible to mark something as deprecated in typescript?

1 Answers1

Linked