Skip to content

lib: add JSDoc typings for assert #38188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
VoltrexKeyva wants to merge 7 commits into from
Closed

lib: add JSDoc typings for assert #38188

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3f89ecb
lib: add JSDoc typings for assert
VoltrexKeyva Apr 10, 2021
066aaae
Fix ifError() description typo
VoltrexKeyva Apr 10, 2021
c8566ac
Change return type
VoltrexKeyva Apr 11, 2021
ac88cb4
Change function type
VoltrexKeyva Apr 11, 2021
a90d6e1
Improve function types
VoltrexKeyva Apr 12, 2021
79c37da
Promise return type
VoltrexKeyva Apr 13, 2021
97639f3
Reduce line length
VoltrexKeyva Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Promise return type 
Some of the functions returned a promise instead of straight up `void`, `void` -> `Promise<void>`.
  • Loading branch information
@VoltrexKeyva
VoltrexKeyva authored Apr 13, 2021
commit 79c37dac6c29e410378684c97095982da900fa62
4 changes: 2 additions & 2 deletions lib/assert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,7 +916,7 @@ assert.throws = function throws(promiseFn, ...args) {
* Expects `promiseFn` function or its value to reject.
* @param {() => Promise<any>} promiseFn
* @param {...any} [args]
* @returns {void}
* @returns {Promise<void>}
*/
assert.rejects = async function rejects(promiseFn, ...args) {
expectsError(rejects, await waitForActual(promiseFn), ...args);
Expand All @@ -936,7 +936,7 @@ assert.doesNotThrow = function doesNotThrow(fn, ...args) {
* Expects `fn` or its value to not reject.
* @param {() => Promise<any>} fn
* @param {...any} [args]
* @returns {void}
* @returns {Promise<void>}
*/
assert.doesNotReject = async function doesNotReject(fn, ...args) {
expectsNoError(doesNotReject, await waitForActual(fn), ...args);
Expand Down