microsoft / microsoft/TypeScript
Unknown interface "ClassMethodDecoratorFunction" in documentation for 5.0.4 lib.decorators.d.ts
Open
Nobody has claimed this yet.
Bug
Docs
Domain: Decorators
Help Wanted
Needs Human Review
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
lib Update Request
Configuration Check
My compilation target is ES2021 and my lib is ["es2017", "dom"].
Missing / Incorrect Definition
The mentioned example:
const bound: ClassMethodDecoratorFunction = (value, context) {
if (context.private) throw new TypeError("Not supported on private methods.");
context.addInitializer(function () {
this[context.name] = this[context.name].bind(this);
});
}
Uses an Interface ClassMethodDecoratorFunction which isn't implemented - as far as I can tell this should be ClassMethodDecoratorContext instead
Documentation Link
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 at src/lib/decorators.d.ts around line 97 and inspect the referenced decorator interfaces. Compare the example's ClassMethodDecoratorFunction reference with the available declaration, then type-check the example to confirm the documentation no longer names an undefined interface.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100