typedoc/jsdoc document generic parameter (callback arguments)

Question

I have the following code:

type AlarmEvent = events.Event<(name: Alarm) => void>;

As you can see, the event class takes a generic parameter in the form of a function signature, which I'd like to document.

Any ideas?

Sean Vieira · Accepted Answer · 2018-01-15 06:06:35Z

1

If all you need is a place to hang normal JSDocs off of, you can just create another type:

type AlarmHandler = (name: Alarm) => void
type AlarmEvent = events.Event<AlarmHandler>

If you need this to work with JSDoc you can use the @callback tag in a standalone JSDoc comment to do the work:

/**
 * Handles alarm events
 * @callback
 * @param {Alarm} name The alarm that fired
*/

answered Jan 15, 2018 at 6:06

Sean Vieira

161k34 gold badges321 silver badges297 bronze badges

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

1 Answer 1