Add TSDoc linter rules

.eslintrc.js

@@ -17,6 +17,7 @@ module.exports = {
   'plugins': [
     'react',
     '@typescript-eslint',
+    'eslint-plugin-tsdoc',
     'import'
   ],
   'rules': {
@@ -56,5 +57,11 @@ module.exports = {
       'import/no-self-import': 'error',
       'import/no-default-export': 'error',
     }
+  }, {
+    // Enable TSDoc rules for TypeScript files, allowing the use of JSDoc in JS files.
+    'files': ['**/*.ts'],
+    'rules': {
+      'tsdoc/syntax': 'warn'
+    }
   }],
 };

package.json

@@ -74,6 +74,7 @@
     "eslint-plugin-compat": "^4.1.2",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-tsdoc": "^0.3.0",
     "husky": "^3.1.0",
     "jest": "^27.2.3",
     "react": "^18.0.0",

src/__tests__/utils/promiseWrapper.ts

@@ -8,8 +8,8 @@
  *  - setting an `onFinally` handler as the first handler (e.g. `promiseWrapper(Promise.reject()).finally(...)`)
  *  - setting more than one handler with at least one of them being an onRejected handler
  *
- * @param customPromise promise to wrap
- * @param defaultOnRejected default onRejected function
+ * @param customPromise - Promise to wrap
+ * @param defaultOnRejected - Default onRejected function
  * @returns a promise that doesn't need to be handled for rejection (except when using async/await syntax).
  */
 export default function promiseWrapper(customPromise: Promise<any>, defaultOnRejected: (_: any) => any): Promise<any> {