docs(lib): add @throws JSDoc for BigInt methods and constructor #61653
Conversation
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
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
Related to #43528 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds
@throwsJSDoc documentation to theBigIntconstructor and methods to clarify their potential error behavior.This helps developers better understand the runtime exceptions these methods may produce, and improves IDE support/documentation.
Related to #43528
Alignment with TypeScript Design Goals:
Test Criteria
This PR only introduces documentation changes in
.d.tsfiles.It does not affect runtime behavior or type system behavior, and therefore does not require test cases.
Note: Technically,
BigInt.prototype.toStringcan throw aTypeErrorif the value ofthisis not aBigInt, such as inBigInt.prototype.toString.call(nonBigIntValue, radix). However, this case is not included in the JSDoc. AddingTypeErrordocumentation for such misuse across prototype methods would introduce noise with limited practical benefit. This behavior is already well understood by developers using.call/.applypatterns on object prototype methods.