fix(check-param-names): avoid erring upon `TSCallSignatureDeclarati…

…on`; fixes #624
gajus · Aug 17, 2020 · 8341f97 · 8341f97
1 parent c140060
commit 8341f97
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2383,6 +2383,17 @@ function quux (foo, {bar}) {
 
 }
 // Options: [{"checkDestructured":false}]
+
+class A {
+  /**
+   * Show a prompt.
+   * @param hideButton true if button should be hidden, false otherwise
+   * @param onHidden delegate to call when the prompt is hidden
+   */
+  public async showPrompt(hideButton: boolean, onHidden: {(): void}): Promise<void>
+  {
+  }
+}
 ````
 
 

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -80,7 +80,11 @@ const flattenRoots = (params, root = '') => {
 
 type T = string | [?string, T];
 const getPropertiesFromPropertySignature = (propSignature): T => {
-  if (propSignature.type === 'TSIndexSignature' || propSignature.type === 'TSConstructSignatureDeclaration') {
+  if (
+    propSignature.type === 'TSIndexSignature' ||
+    propSignature.type === 'TSConstructSignatureDeclaration' ||
+    propSignature.type === 'TSCallSignatureDeclaration'
+  ) {
     return undefined;
   }
   if (propSignature.typeAnnotation && propSignature.typeAnnotation.typeAnnotation.type === 'TSTypeLiteral') {

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -1279,5 +1279,23 @@ export default {
         checkDestructured: false,
       }],
     },
+    {
+      code: `
+      class A {
+        /**
+         * Show a prompt.
+         * @param hideButton true if button should be hidden, false otherwise
+         * @param onHidden delegate to call when the prompt is hidden
+         */
+        public async showPrompt(hideButton: boolean, onHidden: {(): void}): Promise<void>
+        {
+        }
+      }
+`,
+      parser: require.resolve('@typescript-eslint/parser'),
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
 };