How to describe interface method with a type using js docs?

Question

I have the following code:

/**
 * @interface an interface for Foo
 */
interface IFoo {
  init: () => void;
}

class Foo implements IFoo {
  public init(): void {}
}

I want to describe init method with a type like I would for any other param @param {type} name - description, but @param doesn't seem to be a good thing for the method description and the @method can not properly display the type, after trying

 * @method {() => void} init - method for initialization

I get this kind of description:

Is there a proper way for describing interface methods with a type?

maksimr · Accepted Answer · 2022-12-24 12:24:02Z

1

You can omit @ tags and place description in the comment above method or/and interface

/**
 * An interface for Foo
 */
interface IFoo {
  /**
   * method for initialization
   */
  init: () => void;
}

answered Dec 24, 2022 at 12:24

maksimr

5,5214 gold badges26 silver badges27 bronze badges

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

Collectives™ on Stack Overflow

How to describe interface method with a type using js docs?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related