microsoft / microsoft/TypeScript
Define protocol type names for well-known symbols
Open
Nobody has claimed this yet.
Experience Enhancement
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
This is pretty hard to grok. Maybe we should have a named type for types like
{
[Symbol.match](string: string): RegExpMatchArray;
}
It's not totally clear what we'd call these - they're awkward. Something like RegExpMatcher?
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 well-known symbol protocol shape shown in the issue and the surrounding TypeScript library declarations. Determine whether named protocol types such as RegExpMatcher are wanted and how they should be named consistently. Done means the intended declarations and naming are agreed and covered by the relevant type-checking tests.
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
- Needs clarification
- Newbie friendliness
- 25/100