¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? Encontré la @return {{field1: type, field2: type, ...}} description
sintaxis y la probé:
/**
* Returns a coordinate from a given mouse or touch event
* @param {TouchEvent|MouseEvent|jQuery.Event} e
* A valid mouse or touch event or a jQuery event wrapping such an
* event.
* @param {string} [type="page"]
* A string representing the type of location that should be
* returned. Can be either "page", "client" or "screen".
* @return {{x: Number, y: Number}}
* The location of the event
*/
var getEventLocation = function(e, type) {
...
return {x: xLocation, y: yLocation};
}
Si bien esto se analiza con éxito, la documentación resultante simplemente establece:
Returns:
The location of an event
Type: Object
Estoy desarrollando una API y necesito que las personas sepan sobre el objeto que recibirán. ¿Es esto posible en JSDoc? Estoy usando JSDoc3.3.0-beta1.
@typedef
es una solución / solución, pero parece extraño que esto no funcione con objetos literales. Si alguien se topa con esto en el futuro (como lo hice), he agregado un problema github.com/jsdoc/jsdoc/issues/1678 que podría tener más información que esta página.