javascript - example - JSDoc: Estructura de objeto de retorno

jsdoc module exports

Question

¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? Encontré la sintaxis de @return {{field1: type, field2: type, ...}} description 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.

Answer 1

Definir por separado:

/**
* @typedef {Object} Point
* @property {number} x - The X Coordinate
* @property {number} y - The Y Coordinate
*/

Y use:

/**
* 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 {Point}
* The location of the event
*/
var getEventLocation = function(e, type) {
...
return {x: xLocation, y: yLocation};
}

Answer 2

Una alternativa a las sugerencias ya publicadas, puede usar este formato:

/**
* Get the connection state.
*
* @returns {Object} connection The connection state.
* @returns {boolean} connection.isConnected Whether the authenticated user is currently connected.
* @returns {boolean} connection.isPending Whether the authenticated user''s connection is currently pending.
* @returns {Object} connection.error The error object if an error occurred.
* @returns {string} connection.error.message The error message.
* @returns {string} connection.error.stack The stack trace of the error.
*/
getConnection () {
return {
isConnected: true,
isPending: false,
error
}
}

que dará la siguiente salida de documentación:

 Get the connection state.
getConnection(): Object
Returns
Object: connection The connection state.
boolean: connection.isConnected Whether the authenticated user is currently connected.
boolean: connection.isPending Whether the authenticated users connection is currently pending.
Object: connection.error The error object if an error occurred.
string: connection.error.message The error message.
string: connection.error.stack The stack trace of the error.

Answer 3

Una solución limpia es escribir una clase y devolverla.

/**
* @class Point
* @type {Object}
* @property {number} x The X-coordinate.
* @property {number} y The Y-coordinate.
*/
function Point(x, y) {
return {
x: x,
y: y
};
}
/**
* @returns {Point} The location of the event.
*/
var getEventLocation = function(e, type) {
...
return new Point(x, y);
};