microsoft / microsoft/TypeScript
Assign a known symbol to a constant should retain type information
Open
Nobody has claimed this yet.
Awaiting More Feedback
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
Suggestion
Assigning a known symbol constant to another constant should retain type information.
const foo = Symbol() // known symbol
const bar = foo // expecting 'typeof foo' but received 'symbol'
interface UseFoo {
[foo]: 'value'
}
// This should work
const useBar: UseFoo = {
[bar]: 'value'
}
Use Cases
Creating aliases of symbol constants without losing type information.
Examples
Symbol.iterator alias
const { iterator } = Symbol
const iterable: Iterable<number> = {
* [iterator] () {
yield * [0, 1, 2, 3]
}
}
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. new expression-level syntax)
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 reproducing the foo/bar symbol alias example and the Symbol.iterator destructuring example in TypeScript. Trace how the compiler infers the types of these aliases and how computed property keys are checked; done means both examples retain the known symbol type without changing emitted JavaScript.
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
- Clearly specified
- Newbie friendliness
- 35/100