Microsoft/TypeScript

Don't suggest converting custom promise-like returning function to async ones

Open

#40,701 建立於 2020年9月22日

在 GitHub 查看
 (4 留言) (1 反應) (0 負責人)TypeScript (48,455 star) (6,726 fork)batch import
Domain: LS: RefactoringsExperience EnhancementHelp WantedSuggestion

描述

Search Terms

async converted function

Suggestion

Do not suggest that a function is converted to async if its return value is explicitly set to something that is not the global Promise type.

Use Cases

If using a package that provides an extended version of promises (for instance cancellable promises) then the transformation is wrong to occur.

Examples

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

貢獻者指南

技術棧
typescript
領域
developer experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
TypeScript compiler internalsunderstanding of async/await
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
Investigate the TypeScript codebase's code action for converting functions to async, likely in src/services/codeActions.ts. The goal is to modify the condition that suggests async conversion to exclude functions returning custom promise like types not assignable to the global Promise type. Check if there's an existing check for Promise and extend it to respect custom promise types.