javascript - JSDoc：如何正确注释返回承诺的函数，这可能会用不同的类型解析？

Question

我有一个异步函数，它返回一个字符串（令牌）或 false（如果用户未登录）：

const isLoggedIn = async ()=>{
  const token = getToken();
  if(!token){
    return false;
  }
   const { data } = await axios({
    method: "get",
    url: `${rootUrl}/login/isLoggedIn`, //
    headers:{
      token
    }

  });
  if(data.content.isLoggedIn === 'true'){//
     return token;
  }else{
    clear();
    return false;
  }

}

我想知道如何正确记录函数的@return。它应该传达这样一个事实，即承诺可以用字符串或布尔值来解决，如下所示：

* @returns {Promise:string|boolean}

对此有什么约定吗？我什至应该提到该函数返回一个承诺吗？

标签： javascriptjsdoc