bare-ts / lib / 19216304285

91%

push

github

refactor(types): array readers return TypedArray<ArrayBuffer>

BREAKING CHANGES: require TypeScript 5.7 or above

JavaScript has two buffer types: `ArrayBuffer` and `SharedArrayBuffer`.
Before ES2024, TypeScript treated them as a single type.
ES2024 introduced new features for `SharedArrayBuffer`.
So, TypeScript 5.7 added a generic parameter to buffer views.
By default, it is set to `ArrayBufferLike`,
a supertype to `ArrayBuffer` and `SharedArrayBuffer`.
This change is backward compatible.

TypeScript 5.9 went beyond and introduced a breaking change:
Buffer's views no longer extend `ArrayBuffer`.
Moreover, `ArrayBufferLike` cannot be assigned to `ArrayBuffer`.

BARE `read` functions now return a view parametrized with `ArrayBuffer`.
For example, `readU8Array` returns `Uint8Array<ArrayBuffer>`.
Because we now use parametrized views like `Uint8Array<ArrayBuffer>`,
users have to use TypeScript 5.7 or above.

BARE `write` functions still accept view with any buffer types.

261 of 283 branches covered (92.23%)

Branch coverage included in aggregate %.

1067 of 1216 relevant lines covered (87.75%)

25.95 hits per line