microsoft / microsoft/TypeScript
[Compiler API] function which check if a class implements an interface
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
Compiler API, InterfaceDeclaration, ClassDeclaration, Checker
Suggestion
A function to check whether a ClassDeclaration implements an InterfaceDeclaration
Use Cases
Hello, I wanted to check whether a ClassDeclaration of a.ts file implements an InterfaceDeclaration from b.ts file using Compiler API.
But I couldn't find a method or a function for it.
Examples
function isClassImplementInterface(
ts.ClassDeclaration: classDeclaration,
ts.InterfaceDeclaration: interfaceDeclaration
): boolean {
// return true if classDeclaration implements interfaceDeclaration correctly
}
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 reading the Compiler API around InterfaceDeclaration, ClassDeclaration, and the Checker. Determine how cross-file class/interface relationships are represented and what API shape the request requires. Done means agreeing on and documenting a supported function with tests for whether a class implements an interface.
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
- 25/100