Come posso comunicare a JSDoc la struttura di un oggetto che viene restituito. Ho trovato la @return {{field1: type, field2: type, ...}} description
sintassi e l'ho provata:
/**
* 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};
}
Mentre questo analizza correttamente, la documentazione risultante afferma semplicemente:
Returns:
The location of an event
Type: Object
Sto sviluppando un'API e ho bisogno che le persone sappiano dell'oggetto che verranno restituite. È possibile in JSDoc? Sto usando JSDoc3.3.0-beta1.
@typedef
è una soluzione alternativa / soluzione, ma sembra strano che non funzioni con oggetti letterali. Se qualcuno si imbatte in questo in futuro (come ho fatto io) ho aggiunto un problema github.com/jsdoc/jsdoc/issues/1678 che potrebbe avere più informazioni di questa pagina.