microsoft / microsoft/TypeScript

Infer type when object coerced to string if toString explicitly defined

Open
#35,945 2 comments 16 reactions 0 assignees View on GitHub

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

coercion toString computed properties

Suggestion

Infer type when object coerced to string if toString explicitly defined

Examples

Would be nice if the following would be allowed

const action = {
  type: 'foo',
  toString() { return this.type }
} as const;

const reducerHandler = {
  [action]: () => { } // Currently errors: A computed property name must be of type 'string', 'number', 'symbol', or 'any'.
}

Playground

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the linked TypeScript Playground example and inspect the current computed-property-name error. Determine how explicit toString definitions should affect type checking, then verify that the example is accepted without changing emitted JavaScript and that coverage is added for the behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.