microsoft / microsoft/TypeScript

Strongly typed TypedArray values

未关闭
#62,752 6 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
Awaiting More Feedback Suggestion
主要语言
Go
星标
111k
派生
14.3k
平均合并
2 天 4 小时
30 天内合并 PR
132

描述

### 🔍 Search Terms

"TypedArray" "TypedArray value" "indexed value" "value type"

### ✅ Viability Checklist

- [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, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

Enable defining the value type of TypedArrays, similarly to how an Array's value type can be defined using `T[]` or `Array`. This would probably take the form of an additional generic parameter on TypedArray types with a default of `number` applied to keep backwards compatibility.

While Arrays can be defined to use an arbitrary T as their value type, TypedArrays always use the plain `number`. This is runtime-typing-wise correct, of course, but compared to the Array-case it is possible to define an Array that at runtime contains numbers but at the type level contains a subset of numbers, eg. `1 | 2 | 4` or `number & { [BRAND]: unknown }` (note that the "runtime-typing-wise correct" type for general Arrays would be `unknown` or `any`).

TypedArrays, lacking this ability, are harder to use in a code base that wants to use strongly-typed numbers through value unions or branded types. (A further feature which is not litigated here is strongly-typed indexing; the same kind of code base would quite possibly want to define an Array or TypedArray to only be indexed by a given `number & { [BRAND]: unknown }`.)

### 📃 Motivating Example

A TypedArray is used to store unique identifiers, such as indexes (handles) to a particular global storage array.

```typescript
const GLOBAL_DATA_ARRAY: unknown[] = [];

declare const GLOBAL_DATA_HANDLE_BRAND: unique symbol;
type GlobalDataHandle = number & { [GLOBAL_DATA_HANDLE_BRAND]: unknown };

const addData = (data: unknown): GlobalDataHandle => {
const existing = GLOBAL_DATA_ARRAY.indexOf(data);
if (existing !== -1) {
return existing as GlobalDataHandle;
}
const added = GLOBAL_DATA_ARRAY.length as GlobalDataHandle;
GLOBAL_DATA_ARRAY.push(data);
return added;
};

class Foo {
// currently:
#storage: Uint8Array | Uint16Array | Uint32Array;
// in the future:
#storage: Uint8Array | Uint16Array | Uint32Array;
#storageLength: number;

pushData(data: unknown): number {
this.ensureStorage(1); // reallocate #storage if it is full
const index = this.#storageLength++;
this.#storage[index] = addData(data); // okay; GlobalDataHandle is a number.
return index;
}

getDataHandle(index: number): GlobalDataHandle {
return this.#storage[index]; // error: number is not a GlobalDataHandle.
}
}
```

If `#storage` was a plain Array, this same would work without any real issue, but if the code base wants to take advantage of the (possibly) smaller memory footprint and stronger runtime value type guarantees of TypedArrays, they must add a lot of `as GlobalDataHandle` assertions; these assertions are then effectively uncheckable and as a result leads to possibly missing some errors when refactoring.

### 💻 Use Cases

1. Strongly typing TypedArray values to eg. constrain a particular TA to contain "data handles", another to contain "relative indexes", another to contain "data bitsets", and all of these TA value types to be strongly typed so as to be unique from one another and thus not be interchangeable.
2. Currently, `TypedArray & T[]` can sometimes be used but methods on the type become basically unusable, and even the value types seem to sometimes become just plain `number`.
3. The "best" thing to do today is to wrap access to the TypedArray into helper functions that `as` assert the value type: this comes at a small runtime cost as the function does not disappear even though it is entirely trivial in effect.

贡献指南

打开贡献指南

调研方向

从现有的 TypedArray 类型声明以及展示如何在类型化数组中存储和检索带品牌的句柄的动机示例开始。定义泛型值类型应涵盖的范围,包括向后兼容的默认值,然后验证读取和写入会保留请求的值类型,同时不改变生成的 JavaScript。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
compilers
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。