microsoft / microsoft/TypeScript-wiki

Using the Type Checker example gives type errors with typescript 3.6.4

Open
#234 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
759
Forks
315
PR merge metrics
No merged PRs in 30d

Description

This example gives type errors.

docGenerator.ts:65:53 - error TS2554: Expected 1 arguments, but got 0.
documentation: ts.displayPartsToString(symbol.getDocumentationComment()),
docGenerator.ts:99:36 - error TS2345: Argument of type 'Node' is not assignable to parameter of type 'Declaration'.
Property '_declarationBrand' is missing in type 'Node' but required in type 'Declaration'.
(ts.getCombinedModifierFlags(node) & ts.ModifierFlags.Export) !== 0 ||

Contributor guide

No contributing guide indexed for this repository

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 “Using the Type Checker” example and inspect docGenerator.ts around lines 65 and 99. Reproduce the reported errors with TypeScript 3.6.4, then update the example so it type-checks successfully and verify both diagnostics are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.