microsoft / microsoft/TypeScript

Bad error when using `import()` type within JSDoc tag `@implements`

Đang mở
#58,542 2 bình luận 2 reaction 1 người được giao Xem trên GitHub

@sandersn đang làm issue này rồi.

Từ ngày 17/6/2024.

Bug Domain: JSDoc
Ngôn ngữ chính
Go
Star
111k
Fork
14.4k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
117

Mô tả

🔎 Search Terms
  • import
  • @implements
  • 2304
🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about the JSDoc tag @implements
⏯ Playground Link

https://www.typescriptlang.org/play/?ts=5.5.0-beta&filetype=js#code/PQKhAIAEEsFsAcA2BTWyB2AXAzuA3nPAPYBOmAFAEQCGlAlAHQBCAvuCMAFADGi12uAIL4WQA

💻 Code
/** @implements {import("a").B} */
class A {}
🙁 Actual behavior

Two TypeScript errors:

  1. Cannot find name 'import'. (2304)
  2. '}' expected. (2304)
Screenshot 2024-05-15 at 5 59 00 PM
🙂 Expected behavior

TypeScript should allow using import() types within the type of the JSDoc tag @implements.

Additional information about the issue

A workaround is to use a JSDoc @typedef to import the type under an alias, and then use that alias within the JSDoc tag @implements type, e.g:

/** @typedef {import("a").B} B */

/** @implements {B} */
class A {}

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.