microsoft / microsoft/TypeScript
Type JS's `arguments` object based on function parameters
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
type "arguments" object parameters
Suggestion
Within a function x, the type of the arguments object should be Parameters<typeof x> & IArguments, with undefined removed from the type of any entries in Parameters<typeof x> if that parameter has a default value.
Use Cases
class A {
fn(it: number) { return true; }
}
class B extends A {
fn(it: number) {
// this shouldn't error, because arguments must be at least length 1.
// instead we get ERROR: Expected 1 arguments, but got 0 or more.
return super.fn(...arguments);
}
}
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
No source file, test, or compiler entry point is named. Start by reproducing the class A/B example and inspect how the arguments object, Parameters<typeof x>, default parameters, and super.fn(...arguments) are currently checked; done means the example no longer reports the stated argument-count error while preserving runtime behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100