microsoft / microsoft/TypeScript

Private `[Symbol.asyncIterator]` and `[Symbol.iterator]` methods incorrectly reported as unused

Open
#42,051 0 comments 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.2.0-dev.20201219

Search Terms:

Symbol.iterator Symbol.asyncIterator

Code

export class Polling {
  private async *[Symbol.asyncIterator]() {}
  private *[Symbol.iterator]() {}

  async loop() {
    for await (const updates of this) {
      void updates
    }
  }
  syncLoop() {
    for (const updates of this) {
      void updates
    }
  }
}

Expected behavior:
No errors.

Actual behavior:

'[Symbol.asyncIterator]' is declared but its value is never read.
'[Symbol.iterator]' is declared but its value is never read.

Playground Link

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 provided TypeScript 4.2.0-dev reproduction in the Playground, using noUnusedLocals and the async and sync iterator loops. Trace the unused-member diagnostics for the private [Symbol.asyncIterator] and [Symbol.iterator] methods. Done means the reproduction reports no errors while preserving unused-local diagnostics elsewhere.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.