Skip to content

docs: correct the supported BigInt input range - #386

Open
blueDaydreaming725 wants to merge 1 commit into
avoidwork:masterfrom
blueDaydreaming725:docs/bigint-input-range
Open

blueDaydreaming725 wants to merge 1 commit into
avoidwork:masterfrom
blueDaydreaming725:docs/bigint-input-range

Conversation

@blueDaydreaming725

Copy link
Copy Markdown
Contributor

Summary

The README and API comments still say BigInt inputs above Number.MAX_SAFE_INTEGER throw, despite the support added in #355. Describe the actual non-finite Number(arg) rejection and add a 1 EiB example 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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature / enhancement
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Build / dependency / tooling change
  • Test additions or updates
  • Other

Related Issues

Refs #355 and #354. No design document applies.

Testing

Node 24.22.1: npm test passes all 273 tests with 100% line, branch and function coverage; npm run build passes. Checked the README example through both CommonJS and ESM package exports: positive/negative 1024n ** 6n format as 1 EiB / -1 EiB; positive/negative 10n ** 309n throw TypeError. No browser or oldest-Node matrix run.

Checklist

  • npm test passes
  • npm run build succeeds
  • 100% test coverage maintained
  • No hardcoded secrets or credentials introduced
  • Zero external dependencies added
  • ES Modules only (no CommonJS in src/)
  • JSDoc comments added/updated
  • CHANGELOG.md updated (if applicable) — N/A, documentation correction only

Screenshots (if applicable)

N/A — no UI changes.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant