javascript - How to describe a returned promise in a function annotation? -

when writing javascript code, annotate functions like described here, like:

/**  * add 2 values  * @param {number}  * @param {number} b  * @returns {number} sum of , b  */ function add(a, b) {   return + b; } 

now when write asynchronous function returning promise be:

/**  * add 2 values  * @param {number}  * @param {number} b  * @returns {promise} sum of , b  */ function add(a, b) {   return new promise(function (resolve, reject) {     resolve(a + b);   }); } 

but description of return type (promise) misses information on type promise return when resolved.

how denote returned promise resolve number?

i think promise.<number> best (similar array.<number>), haven't found common practice in regard.

what want generics. while jsdoc doesn't officially support yet it's correct way handle it.

the correct way thus: promise.<number>.

documenting promise.<number, error> pointless in opinion since promise rejects error - otoh specifying specific errors can useful, might overkill. promise boxed value on eventual number. correct way document such.