OpenAPITools / OpenAPITools/openapi-generator
[REQ] Add an option to use ReadonlyArray instead of Array in TypeScript client
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
ReadonlyArray is not subtype of Array, so if the generated interfaces use Array type, I have to bother casting array to create an expression that is typed as generated interfaces. On the other hand, Array is a subtype of ReadonlyArray, so there is no practical problem if the interfaces use ReadonlyArray.
But I can not replace Array with ReadonlyArray with CLI options which are currently provided or template customization.
Describe the solution you'd like
Add --useReadonlyArray CLI option
Describe alternatives you've considered
Add a option to overwrite Primitive type setting (include all other types).
Additional context
I've already confirmed that it works by adding the option to typescript-angular
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 typescript-angular generator and its existing CLI option handling, then compare the local change that was confirmed to work. Trace how the option reaches generated interfaces and verify that enabling it produces ReadonlyArray types while leaving the default Array behavior unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100