microsoft / microsoft/TypeScript
Multidimensional readonly arrays
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
readonly array multi multidimensional
Suggestion
The readonly modifier should work with multidimensional arrays.
Use Cases
I assumed readonly number[][] to be multidimensional array which is readonly, but it translates to ReadonlyArray<number[]>, this feels like a footgun.
It is currently also not very intuitive which array is readonly: ReadonlyArray<number>[] or ReadonlyArray<number[]>, without trying it out.
Examples
I'd expect readonly number[][] to be equal to ReadonlyArray<ReadonlyArray<number>>
Explicitely "mixed mutable" arrays could be achieved using parens:
(readonly number[])[] == ReadonlyArray<number>[]
readonly (number[])[] == ReadonlyArray<number[]>
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, etc.)
- 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 by reviewing the proposed meanings for readonly number[][], ReadonlyArray<number>[], and ReadonlyArray<number[]>, along with the parenthesized alternatives. Determine whether the requested shorthand can be specified consistently without changing existing code, then document the accepted semantics and validate them against the listed examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100