Microsoft/TypeScript
Ver no GitHubAssigning a @type to an async function emits an error
Open
#58.215 aberto em 16 de abr. de 2024
BugDomain: JSDocHelp Wanted
Métricas do repositório
- Stars
- (48.455 stars)
- Métricas de merge de PR
- (Mesclagem média 6d 17h) (9 fundiu PRs em 30d)
Description
🔎 Search Terms
ts1065 jsdoc async return promise
🕗 Version & Regression Information
- This changed between versions
5.1.6and5.2.2
⏯ Playground Link
💻 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.