当函数参数为对象时,JavaScript的代码智能感知

时间:2018-12-18 07:21:41

标签: javascript ecmascript-6

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

这样的对象

1 个答案:

答案 0 :(得分:3)

尝试

/**
 * 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){}