Named function arguments not supported in JSDOC

Open
#56,574 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript, typescript
Domain
compilers

Research direction

Start with the supplied JavaScript/JSDoc reproduction and trace how TypeScript parses and checks function types with named parameters. Done means the named argument is accepted without an error and IntelliSense uses that name instead of arg0.

Written by the indexing model from the issue text.

Description

In Discussion Suggestion

Does this issue occur when all extensions are disabled?: Yes

Version: 1.84.2 (user setup)
Commit: 1a5daa3a0231a0fbba4f14db7ec463cf99d7768e
Date: 2023-11-09T10:51:52.184Z
Electron: 25.9.2
ElectronBuildId: 24603566
Chromium: 114.0.5735.289
Node.js: 18.15.0
V8: 11.4.183.29-electron.0
OS: Windows_NT x64 10.0.22621

While defining a function type in JSDOC, if a name if provided for the argument, TypeScript fails to recognize it.

Steps to Reproduce:

This is a snippet of sample code that works and does not work.

The first typedef does not include an argument name, IntelliSense refers to the argument as arg0.

The second typedef does include an argument name, and TypeScript flags it as an error.

/**
* @typedef {function(string ): Promise<string>} IdoRequestFunction
*/

/** @type IdoRequestFunction */

export default async function request(idoRequest) {

    return idoRequest;

}

/**
* @typedef {function(idoRequest:string ): Promise<string>} IdoRequestFunctionX
*/

/** @type IdoRequestFunction */

export async function requestX(idoRequest) {

    return idoRequest;

}

image

Thank you for your assistance.

Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

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.

More from microsoft/TypeScript

All issues in microsoft/TypeScript

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.