Repository navigation
Open
Labels
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featureThis means we'd like to hear from more people who would be helped by this featureSuggestionAn idea for TypeScriptAn idea for TypeScript
Description
Suggestion
🔍 Search Terms
typedarray length tuple typed array
✅ Viability Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
A way to declare a fixed length TypedArray similar to Tuples.
📃 Motivating Example
Consider a hypothetical vector library, similar glmatrix:
function addVector2(out: Float32Array, v1: Float32Array, v2: Float32Array) {
out[0] = v1[0] + v2[0]
out[1] = v1[1] + v2[1]
return out
}There's currently no way to type check that the arguments are indeed Vector2's and not some other Float32Arrays. This is possible with Tuple types though using regular arrays. Since TypedArrays are inherently fixed length even at runtime, it makes sense for there to be some way of declaring length. Even if this is just a minimum length, that would be a huge improvement since that guarantees out of bounds indexing safety.
💻 Use Cases
Many uses of TypedArrays in JS make assumptions about length. But the main one would probably be vectors, matrices, quarternions, etc.
Reacted by whzx5byb, jhmaster, Pim de Wit, GoToLoop, Rubick and Alaric.Baraou
Metadata
Metadata
Assignees
Labels
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featureThis means we'd like to hear from more people who would be helped by this featureSuggestionAn idea for TypeScriptAn idea for TypeScript
Activity
andrewbranch commentedon Aug 24, 2021
Some real-world examples might be helpful here. It feels to me like TS provides 95% of what you need, and you can fake the last 5% with an
astype assertion: playground. Are there severe limitations to an approach like this when brought into the real world?andrewbranch commentedon Aug 24, 2021
Not exactly recommended, but here’s some hacks to make it work for plain old
new Float32Array(length). I don’t think we’d ever add something like this to standard type definitions, but the fact that there are workarounds for cases like these means we’re probably less likely to add something specific to the language for it.fatcerberus commentedon Aug 24, 2021
Not directly related to the issue, but why does the error message in that playground say "Object is possibly undefined"? I was confused for a while because I couldn't figure out why it thought
v1could be undefined. I finally realized that it actually meantv1[0]might be undefined, but there's no object type involved there - the result of the indexing isnumber | undefined. It should probably say "value might be undefined" instead.amw commentedon Oct 1, 2021
I tried to hack something like this, but it doesn't work the way I prayed it would:
It's a bit odd since TypeScript should know that
datais also a tuple.GoToLoop commentedon Jan 13, 2023
I can't pass a spread TypedArray to a function! =(
Can't neither coerce it to a tuple nor make TS know its length.
https://www.TypeScriptLang.org/play?target=9#code/JYWwDg9gTgLgBDAnmApnMBWOAzKERwBEmhAUKSgB6SxwDGEAdgM7wCCAMhwPoDCA8h34AlAMpwAvHAAMlbNjgAeRTIgBmaeQYt4AQyhQAHACFg8KYxQB3OAFVgjGIbYHdiABQBJR2oBMLqDcAOmMATQAVAFFRbgAFSOFuSI5IgFlIgDlwgEpSbVY4ACMAV2wANWBrSThLGwARXRhdCut3fSNTGCCS+RQoXIpqaHhsYsY6GGAmeggAG2gAMTwQP0KzcIgTM2Z3MAAudAwAGnoDxmKQQr7suABvUjhHotKWqyDmFBhvGD93aRO6LknnAoJ9ilBGOgggx5lB3EEEe0tl1mLNgHQUO4AIzZE5IzoAbWkAF1cgBfchUGgjMYTKaQwKMAAm+F4c2guwOmBu92BoJg4MhMMWy1W602nR2YBOYCCjJZIHcnB4AiEYmy5NIQA
GoToLoop commentedon Jan 13, 2023
Well, as a workaround I've had to use Array destructuring assignment for the TypedArray:
Not ideal though. But I can't see any fix in TS for it any time soon.
https://www.TypeScriptLang.org/play?target=9#code/JYWwDg9gTgLgBDAnmApnMBWOAzKERwBEmhAUKSgB6SxwDGEAdgM7wCCAMhwPoDCA8h34AlAMpwAvHAAMlbNjgAeRTIgBmaeQYt4AQyhQAHACFg8KYxQB3OAFVgjGIbYHdiABQBJR2oBMLqDcAOmMATQAVAFFRbgAFSOFuSI5IgFlIgDlwgEpSbVY4ACMAV2wANWBrSThLGwARXRhdCut3fSNTGCCS+RQoXIpqaHhsYsY6GGAmeggAG2gAMTwQP0KzcIgTM2Z3MAAudAwAGnoDxmKQQr7suABvUjhHotKWqyDmFBhvGD93aRO6LknjMdHAANpwXQnKAnADmJ0KcAAutV2lsYA8nlBPsUoIx0EEGPMoO4YXB4UUTrpcgBfchUGgjMYTKb4wKMAAm+F4c2guwOmBu92B2JguPxRMWy1W602nR2YBOYCC7K5IHcnB4AiEYmytKAA