microsoft / microsoft/TypeScript

Overloads do not emit JSDoc on non-implementation signatures

Open
#27,981 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: Comment Emit Experience Enhancement Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 3.2.0-dev.201xxxxx

Search Terms:

Code

.ts file

/**
 * this will lost
 */
function a()
function a() { }

/**
 * this will keep
 */
function b() { }

function c()
/**
 * this will keep, but i don't think this is good way
 */
function c() { }

Expected behavior:

all will keep

/**
 * this will lost
 */
function a() { }
/**
 * this will keep
 */
function b() { }
/**
 * this will keep, but i don't think this is good way
 */
function c() { }

Actual behavior:

a is lost

output .js file

function a() { }
/**
 * this will keep
 */
function b() { }
/**
 * this will keep, but i don't think this is good way
 */
function c() { }

and when it at .d.ts

  • a will keep
  • b will keep too
  • but c will lost

Playground Link:
http://www.typescriptlang.org/play/index.html#src=%2F**%0D%0A%20*%20this%20will%20lost%0D%0A%20*%2F%0D%0Afunction%20a()%0D%0Afunction%20a()%20%7B%20%7D%0D%0A%0D%0A%2F**%0D%0A%20*%20this%20will%20keep%0D%0A%20*%2F%0D%0Afunction%20b()%20%7B%20%7D%0D%0A%0D%0Afunction%20c()%0D%0A%2F**%0D%0A%20*%20this%20will%20keep%2C%20but%20i%20don%27t%20think%20this%20is%20good%20way%0D%0A%20*%2F%0D%0Afunction%20c()%20%7B%20%7D

Related Issues:

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 supplied .ts overload examples or the linked TypeScript Playground, using the reported TypeScript version, and compare the emitted .js and .d.ts output. Done means JSDoc from non-implementation overload signatures is preserved consistently in the relevant output.

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
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.