Repository navigation
docs: correct the supported BigInt input range - #386
Open
blueDaydreaming725 wants to merge 1 commit into
Open
blueDaydreaming725 wants to merge 1 commit into
blueDaydreaming725 wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
Summary
The README and API comments still say BigInt inputs above
Number.MAX_SAFE_INTEGERthrow, despite the support added in #355. Describe the actual non-finiteNumber(arg)rejection and add a1 EiBexample above the safe-integer boundary.This updates documentation rather than changing the supported range. Regenerated distributions carry the same comment correction; runtime code is unchanged. Threat model: no new runtime behaviour, inputs, or dependencies.
Type of Change
Related Issues
Refs #355 and #354. No design document applies.
Testing
Node 24.22.1:
npm testpasses all 273 tests with 100% line, branch and function coverage;npm run buildpasses. Checked the README example through both CommonJS and ESM package exports: positive/negative1024n ** 6nformat as1 EiB/-1 EiB; positive/negative10n ** 309nthrowTypeError. No browser or oldest-Node matrix run.Checklist
npm testpassesnpm run buildsucceedsScreenshots (if applicable)
N/A — no UI changes.