microsoft / microsoft/TypeScript
Revert ts5.9 changes for Uint8Array
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
⚙ Compilation target
es2022
⚙ Library
es2022, dom
Missing / Incorrect Definition
- User sees weird error. "Uint16Array is not assignable to Uint16Array". First thoughts: WTF? What does this even mean? "But I don't use SharedArrayBuffer in my project!!"
TS2345: Argument of type 'Uint16Array' is not assignable to parameter of type 'Uint16Array<ArrayBuffer>'.
Type 'ArrayBufferLike' is not assignable to type 'ArrayBuffer'.
Type 'SharedArrayBuffer' is not assignable to type 'ArrayBuffer'.
Types of property '[Symbol.toStringTag]' are incompatible.
Type '"SharedArrayBuffer"' is not assignable to type '"ArrayBuffer"'.
- User heads to blog post and sees "explicitly writing out
Uint8Array<ArrayBuffer>rather than a plainUint8Array" - User applies the changes.
- The changes make library unusable in TS <=5.6.
- User reverts to older TS to ensure his library doesn't require "latest ts".
- There is zero other documentation about resolving the problem, so it's unclear how to solve it. It's also not obvious that
() => new Uint8Array,() => Uint8Array.from([])and() => Uint8Array.of()now all return subtyped uint8array, which fails in TS <=5.6
Previous issue text
ts5.7 change which made uint8arrays generic was okay.
ts5.9 introduced absolutely horrific change which breaks Uint8Array-heavy projects.
It seems like some changes made types too strict. It's unclear at which phase - perhaps during inference (i'm using infer). I'm now constantly getting those errors and it's really unhelpful - it's unclear what to do. Blog post recommendations (https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-9.html#libdts-changes) make arrays subtype-specific. It seems like this is a wrong way to fix things. Users should not be forced to always consume ArrayBuffer-based type arrays. It's perfectly fine to use either ArrayBuffer or SharedArrayBuffer based arrays, the changes are minor. The defaults should be able to consume both types!
// type Poly = Uint16Array
TS2345: Argument of type 'Poly' is not assignable to parameter of type 'Uint16Array<ArrayBuffer>'.
Type 'ArrayBufferLike' is not assignable to type 'ArrayBuffer'.
Type 'SharedArrayBuffer' is not assignable to type 'ArrayBuffer'.
Types of property '[Symbol.toStringTag]' are incompatible.
Type '"SharedArrayBuffer"' is not assignable to type '"ArrayBuffer"'.
Sample Code
I've spent a lot of time but was not able to produce a standalone example which reproduces the issue. There are a bunch of types at play and it's unclear which exact type causes the issue.
The code which produces errors is in commit cb76058 of https://github.com/paulmillr/noble-post-quantum
git clone https://github.com/paulmillr/noble-post-quantum
cd noble-post-quantum
git checkout cb76058
npm install
npm run build
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 TypeScript 5.9 lib.d.ts changes described in the linked release notes, then reproduce the reported failure using commit cb76058 of noble-post-quantum and its npm run build command. Compare the Uint8Array behavior across TypeScript versions, with done meaning the affected definitions remain usable for both newer and older supported TypeScript versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100