microsoft / microsoft/TypeScript
Officially document type checking behavior for operators WRT bigint
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
bigint operator type checking
Suggestion
I'd like to see official documentation of the design decision TS has made regarding type checking of operators now that bigint
is in play.
Use Cases
The closure-compiler team is currently working on our support for BigInt.
We want to make sure the type design choices we make there are compatible with TS going forward.
It appears that right now when you perform an arithmetic operation on 2 any values, TS infers the result to be of type number, even in ESNext mode where one might expect the result to be number|bigint.
I am inclined to do the same for closure-compiler, but I'd first like to make sure that this behavior was an intentional design choice for TS and not an oversight/bug that is likely to change in the near future.
My point of view on this is that logically the * operator (for example) is overloaded, so there are really 2 versions of it.
- The original
*can take anything (exceptbigint), and always returns anumber. - The new
bigint * bigintversion, which always returns abigint, or throws an exception if one operand is not abigint.
The compiler should assume it's dealing with #1, unless type information indicates it is seeing #2.
Insisting that all operands be clearly typed as bigint if you want bigint results prevents users from
crossing the streams and accidentally mixing bigint and number values in computations.
Examples
- What is the result type of
bigint|number * bigint|number? I expectbigint|numberwith no error message, since you may want to write methods that are intentionally meant to work for either case. - What is the result type of
bigint * any? I expect thebottom/can't happentype, and an error message since we can't be sure that the right operand will be abigintat runtime. - What is the result type of
any * any? I expectnumber(current TS behavior), because it's undesirable for old code to suddenly think it might have abigint, and new code should be explicit about usingbigintto avoid runtime errors.
Checklist
My suggestion meets these guidelines:
- [ X ] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [ X ] This wouldn't change the runtime behavior of existing JavaScript code
- [ X ] This could be implemented without emitting different JS based on the types of the expressions
- [ X ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- [ X ] This feature would agree with the rest of TypeScript's Design Goals.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked TypeScript playground and the operator examples in the issue. Confirm the intended bigint, number, and any rules against current type-checking behavior, then document the decision and rationale in the project's appropriate documentation. Done means the operator behavior and representative cases are officially stated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100