How do you write JSDoc in Javascript for TypeScript Compiler?

Question

I know that there is ability to check JS code with TS compiler. And I know that TS compiler understand JSDoc comments (https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript).

I want to use TS compiler with my React project and I don't know how specify props definitions with JSDoc :(

I've tried

class PropertyDetails extends React.Component {
  static propTypes = {
    breadcrumbChange: PropTypes.func,
    folderId: PropTypes.string.isRequired
  }

  /**
   * @typedef {Object} Props
   * @property {function} breadcrumbChange
   * @property {string} folderId
   */

  /**
   * @constructor
   * @param {Props} props
   */
  constructor(props) {
    super(props);

but it doesn't work.

Simplest solution: Actually use TS and define an interface for Props and use constructor(props: Props) — Gerrit0
– Gerrit0, Commented Dec 6, 2017 at 15:59

Nikolay Osaulenko · Accepted Answer · 2017-12-06 16:05:03Z

1

To make IntelliSense and type checking working you have to specify prop types for Component class since in typings it is described like generic object. So if you try something like this

/**
 * @typedef {Object} Props
 * @prop {Function} breadcrumbChange
 * @prop {string} folderId
 * @extends React.Component<Props>
 */
class PropertyDetails extends React.Component {
}

it should work

answered Dec 6, 2017 at 16:05

Nikolay Osaulenko

1,4821 gold badge12 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

AKnox Over a year ago

narrator: it didn't

Collectives™ on Stack Overflow

How do you write JSDoc in Javascript for TypeScript Compiler?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related