Skip to content
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.

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

lib: add JSDoc typings for assert #38188

Closed
wants to merge 7 commits into from

Conversation

VoltrexKeyva
Copy link
Member

Added JSDoc typings for the assert lib.

Added JSDoc typings for the assert lib.
@nodejs-github-bot nodejs-github-bot added assert Issues and PRs related to the assert subsystem. needs-ci PRs that need a full CI run. labels Apr 10, 2021
Fixed the typo `of` -> `is` of the `ifError()` method's JSDoc description.
lib/assert.js Outdated Show resolved Hide resolved
lib/assert.js Outdated Show resolved Hide resolved
VoltrexKeyva and others added 2 commits April 11, 2021 06:12
void -> never.

Co-authored-by: Bradley Farias <bradley.meck@gmail.com>
Change `Function` -> `() => any`.

Co-authored-by: Bradley Farias <bradley.meck@gmail.com>
@targos targos added the typings label Apr 11, 2021
Copy link
Member

@bmeck bmeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, nits we can improve later if desired

lib/assert.js Outdated Show resolved Hide resolved
lib/assert.js Outdated Show resolved Hide resolved
lib/assert.js Outdated Show resolved Hide resolved
Improved function types by making it indicate what the function's value should be in the parameters.
lib/assert.js Outdated Show resolved Hide resolved
lib/assert.js Outdated Show resolved Hide resolved
Some of the functions returned a promise instead of straight up `void`, `void` -> `Promise<void>`.
Done for checks.
@VoltrexKeyva
Copy link
Member Author

Why does the CI even fail :suspect:

@nodejs-github-bot
Copy link
Collaborator

@targos targos self-assigned this Apr 14, 2021
@nodejs-github-bot
Copy link
Collaborator

@targos
Copy link
Member

targos commented Apr 15, 2021

Landed in 82d5988

@targos targos closed this Apr 15, 2021
targos pushed a commit that referenced this pull request Apr 15, 2021
PR-URL: #38188
Reviewed-By: Bradley Farias <bradley.meck@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@VoltrexKeyva VoltrexKeyva deleted the patch-3 branch April 15, 2021 14:46
targos pushed a commit that referenced this pull request May 1, 2021
PR-URL: #38188
Reviewed-By: Bradley Farias <bradley.meck@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@danielleadams danielleadams mentioned this pull request May 3, 2021
danielleadams pushed a commit that referenced this pull request May 8, 2021
PR-URL: #38188
Reviewed-By: Bradley Farias <bradley.meck@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@targos targos removed their assignment Oct 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assert Issues and PRs related to the assert subsystem. needs-ci PRs that need a full CI run. typings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants