Код intellisense для Javascript, когда функция param является объектом

Question

const _post = params => {
    instance
        .post(params.url, params.data)
        .then(response => {
            params.onSuccess(response);
        })
        .catch(error => {
            params.onFailure(error);
        });
};

Итак, у меня есть этот вспомогательный код, написанный кем-то еще в команде.То, что я ищу, это когда кто-то пытается вызвать эту функцию, он должен сказать им, какие свойства он ожидает.Например, он ожидает три ключа url, data, onSuccess, onFailure

Как мы можем этого добиться.Я попытался посмотреть спецификации JS Doc, но это только позволило нам сказать, что параметр - это объект типа @param {Object} param

Answer 1

Попробуйте

/**
 * some func.
 * @param {Object} params - an object.
 * @param {string} params.url - a url.
 * @param {Object} params.data - an object.
 * @param {Function} params.onSuccess .
 * @param {Function} params.onFailure .
 */
function _post(params){}