Microsoft/TypeScript

Assigning a @type to an async function emits an error

开放

#58,215 创建于 2024年4月16日

 (1 条评论) (1 个反应) (0 位负责人)TypeScript (13,395 个派生)batch import
BugDomain: JSDocHelp Wanted

仓库指标

星标
 (108,860 个星标)
PR 合并指标
 (平均合并 6天 17小时) (30 天内合并 9 个 PR)

描述

🔎 Search Terms

ts1065 jsdoc async return promise

🕗 Version & Regression Information

  • This changed between versions 5.1.6 and 5.2.2

⏯ Playground Link

https://www.typescriptlang.org/play?ts=5.2.2&filetype=js#code/PQKhAIAEBcE8AcCmATRAzcBvAFASnALwB84ACgE4D2AtgJYDOiAPAG6W3IkA+4bHAvuACC9WADsAxgDEx4EMABQC0BBgJEWEeOljB8hRMpj60cNVhbJMwuACGoyeDyESmfkA

💻 Code

JSDoc version:

/** @typedef {() => Promise<void> | void} AsyncFn */

/** @type {AsyncFn} */
const myAsyncFn = async () => {}

TypeScript equivalent:

type AsyncFn = () => Promise<void> | void;

const myAsyncFn : AsyncFn = async () => {}

🙁 Actual behavior

JSDoc version emits an error, TypeScript equivalent does not.

🙂 Expected behavior

Neither should emit an error.

Additional information about the issue

I'm fairly sure this is related to a change from a while back where a new Promise needs to be explicitly marked as returning Promise<void>, which was intentional. But I can't seem to find the related issue anymore so I'm not sure if this is intentional as well.

Either way, the fact that this error is only emitted in JavaScript files seems to suggest that it's a bug.

贡献者指南