2016-03-08 5 views
7

を約束しますErrorは、このコードを考える

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

@returnsとエラーで満たさリターンを指定したい>同様の質問https://stackoverflow.com/questions/13104411/how-へ指定解像度と拒否タイプのjsdoc/46733261#46733261 – holmberd

答えて

14

some other source code's commentsに基づいて次のように表示されます。

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

How JavaScript Promises are documented.

Similar question with a similar answer.その答えのドットの欠如に注意してください。

+0

ドットはオススメですか? JSDocのドキュメントは皮肉なことにあまり良くありません。 – mpen

+0

もう少し詳しくは、こちらをご覧ください:https://stackoverflow.com/a/44726521/828366 –

8

私はそれが@asyncと非同期機能だと指定し、@throws

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

受け入れられる回答でなければなりません。魅力のように動作します。 戻り値がTypeScriptファイルのInterfaceとして定義されている場合(この場合、きちんとしたオートコンプリート用にのみ)、IDEによってこのような結果が正しく認識されます。 – Miraage

+0

ですが、fnは '{Bar}'を返さず、 '{Error}'もスローしません – Mr5o1

関連する問題