Is it possible to mark something as deprecated in typescript?

typescript deprecated deprecation-warning typescript-definitions
lhk picture lhk · Mar 19, 2020 · Viewed 38.6k times · Source

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?

Answer

Vladyslav Zavalykhatko picture Vladyslav Zavalykhatko · Jul 20, 2020

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.

Related questions

React 16.7 - React.SFC is now deprecated

I use to declare stateless components like this: const example: React.SFC<IExample> = ({propsType}) => (); However the SFC is now deprecated, maybe this twitter post from Dan Abramov explains why. What should we use now that SFC is …

Read More
Understanding why super() is deprecated in a React class component

I'm new to React and I'm learning about the React component lifecycle with the latest version of React. My "super" call of the partial code below is flagged with the deprecated warning shown. I've had trouble understanding this one, as …

Read More
How to convert a string to number in TypeScript?

Given a string representation of a number, how can I convert it to number type in TypeScript? var numberString: string = "1234"; var numberValue: number = /* what should I do with `numberString`? */;

Read More