microsoft / microsoft/TypeScript

Union type in element access can prevent deprecated warning from triggering

Open
#41,293 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Domain: LS: Suggestion Diagnostics
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 4.1.0-dev.20201027

Search Terms: Deprecated tag, union, element access

Code

const foo = {
    faff() { },

    /** @deprecated */
    fluff() { }

}

declare const k: "faff" | "fluff";

//Expected: deprecation warning
//Actual: no warning
foo?.[k]?.();

const bar = {
    /** @deprecated */
    faff() { },

    fluff() { }
}

//Expected: deprecation warning
//Actual: deprecation warning
bar?.[k]?.();

Expected behavior:

foo?.[k]?.(); should show deprecated warning because if k is "fluff", then we'll be calling a deprecated method.

Actual behavior:

foo?.[k]?.(); has no deprecated warning.

Playground Link: Playground

Related Issues: Couldn't find any

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

Start with the linked TypeScript Playground reproduction and compare the foo?.[k]?.() and bar?.[k]?.() cases using the reported TypeScript version. Trace how deprecated warnings are produced for optional element access with union keys; done means the foo case reports a deprecation warning without regressing the existing bar case.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.