0
268
VistasCómo definir las propiedades de un objeto devuelto por una función
Estoy trabajando en Gscript.
function globales() { var data = { dir: DriveApp.getFolderById('id'), sinky: "test", numberino : 42 }; return data; } function test() { var rep = globales().dir.getName() // get the name of the directory. return rep }Me gustaría usar jsdoc para que cuando escriba este código, el tipo de retorno de la variable "dir" pueda mostrar 'DriveApp.Folder'. Básicamente, especifique para todas las claves dentro de la estructura de 'datos' en la función 'global': el tipo de datos (por ejemplo, una cadena, un número, una DriveApp.Folder)
Algo así como @param {string} para precisar el tipo de parámetro de función.
1 Respuestas
Responde la pregunta0
Parece que estás buscando la etiqueta @property . Según su código, puede intentar algo como lo siguiente:
/** *Returns an Object with some global variables * *@function globales *@property {DriveApp.Folder} dir - Folder ID *@property {String} sinky - Some string *@property {int} numberino - Some number *@returns {Object} - Array with different data * */ function globales() { var data = { dir: DriveApp.getFolderById('id'), sinky: "test", numberino : 42 }; return data; } function test() { var rep = globales().dir.getName() // get the name of the directory. return rep }Y el resultado en la documentación sería:
Puede variar dependiendo de cómo quieras formatearlo, pero esto debería funcionar. Si su función tiene parámetros de entrada, puede usar la etiqueta @param y agregará una tabla separada.