chore: dedup and clean and fix comments

typescript-eslint · Mar 1, 2022 · 1911f45 · 1911f45
1 parent 0425fe8
commit 1911f45
Showing 1 changed file with 37 additions and 23 deletions.
diff --git a/packages/eslint-plugin/src/rules/no-misused-promises.ts b/packages/eslint-plugin/src/rules/no-misused-promises.ts
@@ -431,61 +431,75 @@ function voidFunctionParams(
   return voidReturnIndices;
 }
 
-// Returns true if given type is a void-returning function.
-function isVoidReturningFunctionType(
+/**
+ * @returns Whether any call signature of the type has a thenable return type.
+ */
+function anySignatureIsThenableType(
   checker: ts.TypeChecker,
   node: ts.Node,
   type: ts.Type,
 ): boolean {
-  for (const subType of tsutils.unionTypeParts(type)) {
-    for (const signature of subType.getCallSignatures()) {
-      const returnType = signature.getReturnType();
+  for (const signature of type.getCallSignatures()) {
+    const returnType = signature.getReturnType();
+    if (tsutils.isThenableType(checker, node, returnType)) {
+      return true;
+    }
+  }
 
-      // If a certain positional argument accepts both thenable and void returns,
-      // a promise-returning function is valid
-      if (tsutils.isThenableType(checker, node, returnType)) {
-        return false;
-      }
+  return false;
+}
 
-      if (tsutils.isTypeFlagSet(returnType, ts.TypeFlags.Void)) {
-        return true;
-      }
+/**
+ * @returns Whether type is a thenable-returning function.
+ */
+function isThenableReturningFunctionType(
+  checker: ts.TypeChecker,
+  node: ts.Node,
+  type: ts.Type,
+): boolean {
+  for (const subType of tsutils.unionTypeParts(type)) {
+    if (anySignatureIsThenableType(checker, node, subType)) {
+      return true;
     }
   }
+
   return false;
 }
 
 /**
  * @returns Whether type is a void-returning function.
  */
-function isThenableReturningFunctionType(
+function isVoidReturningFunctionType(
   checker: ts.TypeChecker,
   node: ts.Node,
   type: ts.Type,
 ): boolean {
   for (const subType of tsutils.unionTypeParts(type)) {
     for (const signature of subType.getCallSignatures()) {
       const returnType = signature.getReturnType();
+
+      // If a certain positional argument accepts both thenable and void returns,
+      // a promise-returning function is valid
       if (tsutils.isThenableType(checker, node, returnType)) {
+        return false;
+      }
+
+      if (tsutils.isTypeFlagSet(returnType, ts.TypeFlags.Void)) {
         return true;
       }
     }
   }
-
   return false;
 }
 
-// Returns true if the expression is a function that returns a thenable
+/**
+ * @returns Whether expression is a function that returns a thenable.
+ */
 function returnsThenable(checker: ts.TypeChecker, node: ts.Node): boolean {
   const type = checker.getApparentType(checker.getTypeAtLocation(node));
 
-  for (const subType of tsutils.unionTypeParts(type)) {
-    for (const signature of subType.getCallSignatures()) {
-      const returnType = signature.getReturnType();
-      if (tsutils.isThenableType(checker, node, returnType)) {
-        return true;
-      }
-    }
+  if (anySignatureIsThenableType(checker, node, type)) {
+    return true;
   }
 
   return false;