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。它应该传达这样的事实，即可以用字符串或布尔值来解决promise，如下所示：

* @returns {Promise:string|boolean}

关于此是否有约定？我什至应该提到该函数返回一个诺言吗？