matrix-org / matrix-org/matrix-js-sdk
Switch away from using method-defined `interface`s for base-class definition
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 704
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 40
Description
interface ClassInterface {
callable(f: string | number): void;
}
class Thing implements ClassInterface {
public callable(f: string): void {
}
}
class OtherThing implements ClassInterface {
public callable(f: number): void {
}
}
Related to https://github.com/matrix-org/matrix-js-sdk/issues/2113, using interfaces can cause above situations, where any person going from an interface definition will possibly draw the wrong conclusions.
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 method-defined interfaces and their implementing classes shown in the issue, then read related issue #2113 for context. Done means the base-class contract no longer relies on these interfaces and the resulting declarations accurately communicate each implementation's callable signature.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100