lib: improve hideStackFrames intellisense #44181
Conversation
nodejs-github-bot
added
errors
Why do you say it was invalid? What warning do you see? |
In TypeScript, the return type for this kind of functions is |
@aduh95 The previous error for all functions that use
@targos Most of our validate functions does not return a value, but throw's an error if assertion fails. In that scenario, |
|
@anonrig Note the |
|
Changing /**
* @function validateInteger
* @param {never} value
* @param {string} name
* @param {number=} min
* @param {number=} max
* @returns {asserts value is number}
*/
|
|
Can we not use the Closure Compiler syntax? We should be using JSDoc instead: /**
* @callback myCallback
* @param {number} mandatory
* @param {number} [optional]
*/
/** @type {myCallback} */
var cb; |
|
I did not really quite understand your point since JSDoc lacks certain functionality. JSDoc does not have /**
* @function validateOneOf
* @template T
* @param {T} value
* @param {string} name
* @param {T[]} oneOf
*/ |
|
Thanks for the review @aduh95. I've fixed them all. |
aduh95
added
author ready
|
Landed in ab9b590, thanks for the contribution 🎉 |
PR-URL: #44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: nodejs#44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: #44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: #44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: #44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: #44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: #44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: nodejs/node#44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
PR-URL: nodejs/node#44181 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
This is a draft pull request to improve the developer experience by fixing internal function's JSDoc declarations. I wanted to receive some feedback before investing time on this.
Previously, all functions that uses hideStackFrames was invalidly typed and was shown as a warning in IDEs (On WebStorm and Sublime).
I wanted to introduce
T is booleankind of type guards into the functions but could not find a solution for functions that does not return any boolean, but throws an error.