Возвращение объекта с определенным свойством и типа

Question

У меня есть функция operation, которая принимает два аргумента str (a String) и fn (a Function).

function operation(str, fn){ 
    var temp = {} 
    temp[str] = fn 
    return temp 
} 

• Как вы описываете это возвращаемое значение?
• Как выглядит это возвращаемое значение в JSDoc?
• Каков пример формата вывода?

Это приемлемо для описания @return?

@returns {Object} With one key set to str and one value set to fn. 

Возможно ли это для вывода @example?

operation("foo", console.log) 
// => {"foo": [Function]} 

Основная причина, почему я спрашиваю, потому что я хотел бы использовать этот формат для тестирования функции в пределах пакета, как yamadapc/jsdoctest.

Answer 1

На мой взгляд, вы должны использовать оба them.For exampe, в underscorejs, док является описать, как сотрудник: