Refactor JSDoc for auth function: Clarify return type and document errors - #62
Closed
Ayoub-Mabrouk wants to merge 1 commit into
Closed
Refactor JSDoc for auth function: Clarify return type and document errors#62Ayoub-Mabrouk wants to merge 1 commit into
auth function: Clarify return type and document errors#62Ayoub-Mabrouk wants to merge 1 commit into
Conversation
…errors in JSDoc
- Refined the return type in JSDoc to `(Credentials|undefined)` to match the actual return value.
- Added `@throws {TypeError}` in JSDoc to document errors thrown for invalid `req` parameter.
Member
|
I'm going to close this out as we're moving to TypeScript types in the next major, and it's unlikely to be released in the previous major. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactor JSDoc for
authfunction: Clarify return type and documented errors(Credentials|undefined)to match the actual return value.@throws {TypeError}in JSDoc to document errors thrown for invalidreqparameter.