Wie aufgelöst Werte von JavaScript zu dokumentieren versprechen

Question

Vor diesem Code:

function asyncFoo() { 
    return new Promise(function (fulfill, reject) { 
    doAsyncStuff(function(err, data) { 
     if(err) reject(new Error(err)); 
     else fulfill(new Bar(data)); 
    }); 
    }); 
} 

Wie kann ich dokumentieren, dass asyncFoo ein Promise zurück, die, wenn eine Instanz von Bar nachgeben erfüllt, und wenn abgelehnt wird eine Instanz ergeben von Error?

/** 
* @return << Here, what do I have to write? >> 
*/ 
function asyncFoo() { ... } 

Answer 1

Sieht aus wie Sie die folgende tun sollten, basierend auf some other source code's comments.

/** 
* @return {Promise.<Bar>} 
*/ 

How JavaScript Promises are documented.

Similar question with a similar answer. Hinweis der Mangel an einem Punkt in dieser Antwort.

Answer 2

Ich mag angeben, dass es eine Asynchron-Funktion mit @async und geben Sie die erfüllte Rückkehr mit @returns und Fehlern mit @throws

/** 
* @async 
* @returns {Bar} 
* @throws {Error} 
*/ 
function asyncFoo() { ... }