From 9f8662c0a12546f8955fa5c3521f2fa9f361820c Mon Sep 17 00:00:00 2001 From: Horatiu Muresan <39557534+horymury@users.noreply.github.com> Date: Tue, 27 Feb 2024 12:56:05 +0200 Subject: [PATCH] chore(eslint) Update eslint (#14412) --- package-lock.json | 215 ++++++++++-------- package.json | 4 +- .../analytics/handlers/AmplitudeHandler.ts | 2 +- .../handlers/GoogleAnalyticsHandler.ts | 4 +- .../analytics/handlers/MatomoHandler.ts | 4 +- react/features/authentication/actions.any.ts | 2 +- .../components/web/LoginQuestionDialog.tsx | 2 +- react/features/base/config/functions.web.ts | 3 +- .../base/modal/components/functions.native.ts | 4 +- .../{actionTypes.tsx => actionTypes.ts} | 0 react/features/base/util/helpers.ts | 2 +- .../chat/components/web/MessageContainer.tsx | 2 +- .../components/native/carmode/AudioIcon.tsx | 1 - react/features/conference/functions.any.ts | 2 +- .../connection-indicator/statsEmitter.ts | 4 +- react/features/dynamic-branding/reducer.ts | 2 +- react/features/e2ee/functions.ts | 4 +- .../filmstrip/components/native/Filmstrip.tsx | 2 +- .../features/screenshot-capture/constants.ts | 15 +- .../settings/components/web/LogoutDialog.tsx | 2 +- .../virtual-background/TimerWorker.ts | 15 +- .../toolbox/components/native/Toolbox.tsx | 2 +- .../features/virtual-background/functions.ts | 1 - react/features/web-hid/webhid-manager.ts | 2 +- 24 files changed, 168 insertions(+), 128 deletions(-) rename react/features/base/tooltip/{actionTypes.tsx => actionTypes.ts} (100%) diff --git a/package-lock.json b/package-lock.json index d17aca20cd..6e9e627fec 100644 --- a/package-lock.json +++ b/package-lock.json @@ -125,7 +125,7 @@ "@babel/plugin-proposal-export-default-from": "7.22.5", "@babel/preset-env": "7.21.5", "@babel/preset-react": "7.16.0", - "@jitsi/eslint-config": "4.1.5", + "@jitsi/eslint-config": "4.1.10", "@types/amplitude-js": "8.16.5", "@types/audioworklet": "0.0.29", "@types/dom-screen-wake-lock": "1.0.1", @@ -157,7 +157,7 @@ "css-loader": "6.8.1", "eslint": "8.40.0", "eslint-plugin-import": "2.27.5", - "eslint-plugin-jsdoc": "37.0.3", + "eslint-plugin-jsdoc": "46.2.6", "eslint-plugin-react": "7.32.2", "eslint-plugin-react-native": "4.0.0", "eslint-plugin-typescript-sort-keys": "2.3.0", @@ -2943,26 +2943,17 @@ "integrity": "sha512-6U71C2Wp7r5XtFtQzYrW5iKFT67OixrSxjI4MptCHzdSVlgabczzqLe0ZSgnub/5Kp4hSbpDB1tMytZY9pwxxA==" }, "node_modules/@es-joy/jsdoccomment": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.12.0.tgz", - "integrity": "sha512-Gw4/j9v36IKY8ET+W0GoOzrRw17xjf21EIFFRL3zx21fF5MnqmeNpNi+PU/LKjqLpPb2Pw2XdlJbYM31VVo/PQ==", + "version": "0.39.4", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.39.4.tgz", + "integrity": "sha512-Jvw915fjqQct445+yron7Dufix9A+m9j1fCJYlCo1FWlRvTxa3pjJelxdSTdaLWcTwRU6vbL+NYjO4YuNIS5Qg==", "dev": true, "dependencies": { - "comment-parser": "1.2.4", - "esquery": "^1.4.0", - "jsdoc-type-pratt-parser": "2.0.0" + "comment-parser": "1.3.1", + "esquery": "^1.5.0", + "jsdoc-type-pratt-parser": "~4.0.0" }, "engines": { - "node": "^12 || ^14 || ^16 || ^17" - } - }, - "node_modules/@es-joy/jsdoccomment/node_modules/jsdoc-type-pratt-parser": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-2.0.0.tgz", - "integrity": "sha512-sUuj2j48wxrEpbFjDp1sAesAxPiLT+z0SWVmMafyIINs6Lj5gIPKh3VrkBZu4E/Dv+wHpOot0m6H8zlHQjwqeQ==", - "dev": true, - "engines": { - "node": ">=12.0.0" + "node": ">=16" } }, "node_modules/@eslint-community/eslint-utils": { @@ -3454,9 +3445,9 @@ } }, "node_modules/@jitsi/eslint-config": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/@jitsi/eslint-config/-/eslint-config-4.1.5.tgz", - "integrity": "sha512-UgyXdk1n9lSEQu9QeS09dEb3nnAoh/2wyqwxYlswlvB3f/AK83DoXx5SZtSBOH6di3DJJ3qcqhTE4t4pw9OjVQ==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@jitsi/eslint-config/-/eslint-config-4.1.10.tgz", + "integrity": "sha512-xUfuhYmmvNrwWvk3QfgKlNY/O3l19ffVTofj1dDbI6kLXfC9B1FZ++09q1d8hm47m7rgIylNCQ1eV5XF6SohbA==", "dev": true, "peerDependencies": { "@babel/eslint-parser": ">= 7", @@ -7697,6 +7688,15 @@ "extend": "^3.0.2" } }, + "node_modules/are-docs-informative": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz", + "integrity": "sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==", + "dev": true, + "engines": { + "node": ">=14" + } + }, "node_modules/argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -8734,9 +8734,9 @@ "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" }, "node_modules/comment-parser": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz", - "integrity": "sha512-pm0b+qv+CkWNriSTMsfnjChF9kH0kxz55y44Wo5le9qLxMj5xDQAaEd9ZN1ovSuk9CsrncWaFwgpOMg7ClJwkw==", + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.3.1.tgz", + "integrity": "sha512-B52sN2VNghyq5ofvUsqZjmk6YkihBX5vMSChmSK9v4ShjKf3Vk5Xcmgpw4o+iIgtrnM/u5FiMpz9VKb8lpBveA==", "dev": true, "engines": { "node": ">= 12.0.0" @@ -9858,28 +9858,55 @@ } }, "node_modules/eslint-plugin-jsdoc": { - "version": "37.0.3", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-37.0.3.tgz", - "integrity": "sha512-Qg/gIZAfcrM4Qu/JzcnxPGD45Je6wPLFzMZQboeqit/CL4aY6wuzBTkgUMiWXfw/PaPl+sb0GF1XdBlV23ReDA==", + "version": "46.2.6", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-46.2.6.tgz", + "integrity": "sha512-zIaK3zbSrKuH12bP+SPybPgcHSM6MFzh3HFeaODzmsF1N8C1l8dzJ22cW1aq4g0+nayU1VMjmNf7hg0dpShLrA==", "dev": true, "dependencies": { - "@es-joy/jsdoccomment": "0.12.0", - "comment-parser": "1.2.4", - "debug": "^4.3.2", - "esquery": "^1.4.0", - "jsdoc-type-pratt-parser": "^2.0.0", - "lodash": "^4.17.21", - "regextras": "^0.8.0", - "semver": "^7.3.5", + "@es-joy/jsdoccomment": "~0.39.4", + "are-docs-informative": "^0.0.2", + "comment-parser": "1.3.1", + "debug": "^4.3.4", + "escape-string-regexp": "^4.0.0", + "esquery": "^1.5.0", + "is-builtin-module": "^3.2.1", + "semver": "^7.5.1", "spdx-expression-parse": "^3.0.1" }, "engines": { - "node": "^12 || ^14 || ^16 || ^17" + "node": ">=16" }, "peerDependencies": { "eslint": "^7.0.0 || ^8.0.0" } }, + "node_modules/eslint-plugin-jsdoc/node_modules/builtin-modules": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", + "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==", + "dev": true, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint-plugin-jsdoc/node_modules/is-builtin-module": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz", + "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==", + "dev": true, + "dependencies": { + "builtin-modules": "^3.3.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/eslint-plugin-react": { "version": "7.32.2", "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.32.2.tgz", @@ -10305,9 +10332,9 @@ } }, "node_modules/esquery": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.2.tgz", - "integrity": "sha512-JVSoLdTlTDkmjFmab7H/9SL9qGSyjElT3myyKp7krqjVFQCDLmj1QFaCLRFBszBKI0XVZaiiXvuPIX3ZwHe1Ng==", + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.5.0.tgz", + "integrity": "sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg==", "dev": true, "dependencies": { "estraverse": "^5.1.0" @@ -12594,9 +12621,9 @@ } }, "node_modules/jsdoc-type-pratt-parser": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-2.2.3.tgz", - "integrity": "sha512-QPyxq62Q8veBSDtDrWmqaEPjSCeknUV9dH/OAGt3q9an8qC8UQDqitQiw1NvoMskIESpoRZ6qzt4H3rlK0xo8A==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", + "integrity": "sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==", "dev": true, "engines": { "node": ">=12.0.0" @@ -17203,15 +17230,6 @@ "node": ">=4" } }, - "node_modules/regextras": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/regextras/-/regextras-0.8.0.tgz", - "integrity": "sha512-k519uI04Z3SaY0fLX843MRXnDeG2+vHOFsyhiPZvNLe7r8rD2YNRjq4BQLZZ0oAr2NrtvZlICsXysGNFPGa3CQ==", - "dev": true, - "engines": { - "node": ">=0.1.14" - } - }, "node_modules/regjsparser": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.9.1.tgz", @@ -21848,22 +21866,14 @@ "integrity": "sha512-6U71C2Wp7r5XtFtQzYrW5iKFT67OixrSxjI4MptCHzdSVlgabczzqLe0ZSgnub/5Kp4hSbpDB1tMytZY9pwxxA==" }, "@es-joy/jsdoccomment": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.12.0.tgz", - "integrity": "sha512-Gw4/j9v36IKY8ET+W0GoOzrRw17xjf21EIFFRL3zx21fF5MnqmeNpNi+PU/LKjqLpPb2Pw2XdlJbYM31VVo/PQ==", + "version": "0.39.4", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.39.4.tgz", + "integrity": "sha512-Jvw915fjqQct445+yron7Dufix9A+m9j1fCJYlCo1FWlRvTxa3pjJelxdSTdaLWcTwRU6vbL+NYjO4YuNIS5Qg==", "dev": true, "requires": { - "comment-parser": "1.2.4", - "esquery": "^1.4.0", - "jsdoc-type-pratt-parser": "2.0.0" - }, - "dependencies": { - "jsdoc-type-pratt-parser": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-2.0.0.tgz", - "integrity": "sha512-sUuj2j48wxrEpbFjDp1sAesAxPiLT+z0SWVmMafyIINs6Lj5gIPKh3VrkBZu4E/Dv+wHpOot0m6H8zlHQjwqeQ==", - "dev": true - } + "comment-parser": "1.3.1", + "esquery": "^1.5.0", + "jsdoc-type-pratt-parser": "~4.0.0" } }, "@eslint-community/eslint-utils": { @@ -22236,9 +22246,9 @@ } }, "@jitsi/eslint-config": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/@jitsi/eslint-config/-/eslint-config-4.1.5.tgz", - "integrity": "sha512-UgyXdk1n9lSEQu9QeS09dEb3nnAoh/2wyqwxYlswlvB3f/AK83DoXx5SZtSBOH6di3DJJ3qcqhTE4t4pw9OjVQ==", + "version": "4.1.10", + "resolved": "https://registry.npmjs.org/@jitsi/eslint-config/-/eslint-config-4.1.10.tgz", + "integrity": "sha512-xUfuhYmmvNrwWvk3QfgKlNY/O3l19ffVTofj1dDbI6kLXfC9B1FZ++09q1d8hm47m7rgIylNCQ1eV5XF6SohbA==", "dev": true }, "@jitsi/excalidraw": { @@ -25396,6 +25406,12 @@ "extend": "^3.0.2" } }, + "are-docs-informative": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz", + "integrity": "sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==", + "dev": true + }, "argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -26165,9 +26181,9 @@ "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" }, "comment-parser": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz", - "integrity": "sha512-pm0b+qv+CkWNriSTMsfnjChF9kH0kxz55y44Wo5le9qLxMj5xDQAaEd9ZN1ovSuk9CsrncWaFwgpOMg7ClJwkw==", + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.3.1.tgz", + "integrity": "sha512-B52sN2VNghyq5ofvUsqZjmk6YkihBX5vMSChmSK9v4ShjKf3Vk5Xcmgpw4o+iIgtrnM/u5FiMpz9VKb8lpBveA==", "dev": true }, "commondir": { @@ -27205,20 +27221,37 @@ } }, "eslint-plugin-jsdoc": { - "version": "37.0.3", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-37.0.3.tgz", - "integrity": "sha512-Qg/gIZAfcrM4Qu/JzcnxPGD45Je6wPLFzMZQboeqit/CL4aY6wuzBTkgUMiWXfw/PaPl+sb0GF1XdBlV23ReDA==", + "version": "46.2.6", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-46.2.6.tgz", + "integrity": "sha512-zIaK3zbSrKuH12bP+SPybPgcHSM6MFzh3HFeaODzmsF1N8C1l8dzJ22cW1aq4g0+nayU1VMjmNf7hg0dpShLrA==", "dev": true, "requires": { - "@es-joy/jsdoccomment": "0.12.0", - "comment-parser": "1.2.4", - "debug": "^4.3.2", - "esquery": "^1.4.0", - "jsdoc-type-pratt-parser": "^2.0.0", - "lodash": "^4.17.21", - "regextras": "^0.8.0", - "semver": "^7.3.5", + "@es-joy/jsdoccomment": "~0.39.4", + "are-docs-informative": "^0.0.2", + "comment-parser": "1.3.1", + "debug": "^4.3.4", + "escape-string-regexp": "^4.0.0", + "esquery": "^1.5.0", + "is-builtin-module": "^3.2.1", + "semver": "^7.5.1", "spdx-expression-parse": "^3.0.1" + }, + "dependencies": { + "builtin-modules": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", + "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==", + "dev": true + }, + "is-builtin-module": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz", + "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==", + "dev": true, + "requires": { + "builtin-modules": "^3.3.0" + } + } } }, "eslint-plugin-react": { @@ -27357,9 +27390,9 @@ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==" }, "esquery": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.2.tgz", - "integrity": "sha512-JVSoLdTlTDkmjFmab7H/9SL9qGSyjElT3myyKp7krqjVFQCDLmj1QFaCLRFBszBKI0XVZaiiXvuPIX3ZwHe1Ng==", + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.5.0.tgz", + "integrity": "sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg==", "dev": true, "requires": { "estraverse": "^5.1.0" @@ -29032,9 +29065,9 @@ } }, "jsdoc-type-pratt-parser": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-2.2.3.tgz", - "integrity": "sha512-QPyxq62Q8veBSDtDrWmqaEPjSCeknUV9dH/OAGt3q9an8qC8UQDqitQiw1NvoMskIESpoRZ6qzt4H3rlK0xo8A==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", + "integrity": "sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==", "dev": true }, "jsesc": { @@ -32341,12 +32374,6 @@ "unicode-match-property-value-ecmascript": "^2.1.0" } }, - "regextras": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/regextras/-/regextras-0.8.0.tgz", - "integrity": "sha512-k519uI04Z3SaY0fLX843MRXnDeG2+vHOFsyhiPZvNLe7r8rD2YNRjq4BQLZZ0oAr2NrtvZlICsXysGNFPGa3CQ==", - "dev": true - }, "regjsparser": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.9.1.tgz", diff --git a/package.json b/package.json index 0af03d59c2..a9cd97a5f1 100644 --- a/package.json +++ b/package.json @@ -131,7 +131,7 @@ "@babel/plugin-proposal-export-default-from": "7.22.5", "@babel/preset-env": "7.21.5", "@babel/preset-react": "7.16.0", - "@jitsi/eslint-config": "4.1.5", + "@jitsi/eslint-config": "4.1.10", "@types/amplitude-js": "8.16.5", "@types/audioworklet": "0.0.29", "@types/dom-screen-wake-lock": "1.0.1", @@ -163,7 +163,7 @@ "css-loader": "6.8.1", "eslint": "8.40.0", "eslint-plugin-import": "2.27.5", - "eslint-plugin-jsdoc": "37.0.3", + "eslint-plugin-jsdoc": "46.2.6", "eslint-plugin-react": "7.32.2", "eslint-plugin-react-native": "4.0.0", "eslint-plugin-typescript-sort-keys": "2.3.0", diff --git a/react/features/analytics/handlers/AmplitudeHandler.ts b/react/features/analytics/handlers/AmplitudeHandler.ts index ebcfbf3e83..cc7268b612 100644 --- a/react/features/analytics/handlers/AmplitudeHandler.ts +++ b/react/features/analytics/handlers/AmplitudeHandler.ts @@ -14,7 +14,7 @@ export default class AmplitudeHandler extends AbstractHandler { /** * Creates new instance of the Amplitude analytics handler. * - * @param {Object} options - + * @param {Object} options - The amplitude options. * @param {string} options.amplitudeAPPKey - The Amplitude app key required by the Amplitude API. * @param {boolean} options.amplitudeIncludeUTM - Whether to include UTM parameters * in the Amplitude events. diff --git a/react/features/analytics/handlers/GoogleAnalyticsHandler.ts b/react/features/analytics/handlers/GoogleAnalyticsHandler.ts index adb64cae1f..9845cd6c30 100644 --- a/react/features/analytics/handlers/GoogleAnalyticsHandler.ts +++ b/react/features/analytics/handlers/GoogleAnalyticsHandler.ts @@ -14,7 +14,7 @@ class GoogleAnalyticsHandler extends AbstractHandler { /** * Creates new instance of the GA analytics handler. * - * @param {Object} options - + * @param {Object} options - The Google Analytics options. * @param {string} options.googleAnalyticsTrackingId - The GA track id * required by the GA API. */ @@ -34,7 +34,7 @@ class GoogleAnalyticsHandler extends AbstractHandler { /** * Initializes the ga object. * - * @param {Object} options - + * @param {Object} options - The Google Analytics options. * @param {string} options.googleAnalyticsTrackingId - The GA track id * required by the GA API. * @returns {void} diff --git a/react/features/analytics/handlers/MatomoHandler.ts b/react/features/analytics/handlers/MatomoHandler.ts index 1f749934bd..90fa332095 100644 --- a/react/features/analytics/handlers/MatomoHandler.ts +++ b/react/features/analytics/handlers/MatomoHandler.ts @@ -13,7 +13,7 @@ export default class MatomoHandler extends AbstractHandler { /** * Creates new instance of the Matomo handler. * - * @param {Object} options - + * @param {Object} options - The matomo options. * @param {string} options.matomoEndpoint - The Matomo endpoint. * @param {string} options.matomoSiteID - The site ID. */ @@ -39,7 +39,7 @@ export default class MatomoHandler extends AbstractHandler { /** * Initializes the _paq object. * - * @param {Object} options - + * @param {Object} options - The matomo options. * @param {string} options.matomoEndpoint - The Matomo endpoint. * @param {string} options.matomoSiteID - The site ID. * @returns {void} diff --git a/react/features/authentication/actions.any.ts b/react/features/authentication/actions.any.ts index 32ffdf3665..89cdfee4f7 100644 --- a/react/features/authentication/actions.any.ts +++ b/react/features/authentication/actions.any.ts @@ -133,7 +133,7 @@ function _upgradeRoleStarted(thenableWithCancel: Object) { * Hides an authentication dialog where the local participant * should authenticate. * - * @returns {Function}. + * @returns {Function} */ export function hideLoginDialog() { return hideDialog(LoginDialog); diff --git a/react/features/authentication/components/web/LoginQuestionDialog.tsx b/react/features/authentication/components/web/LoginQuestionDialog.tsx index 0f88db1445..e2a172f851 100644 --- a/react/features/authentication/components/web/LoginQuestionDialog.tsx +++ b/react/features/authentication/components/web/LoginQuestionDialog.tsx @@ -18,7 +18,7 @@ interface IProps { * Implements the dialog that warns the user that the login will leave the conference. * * @param {Object} props - The props of the component. - * @returns {React$Element}. + * @returns {React$Element} */ const LoginQuestionDialog = ({ handler }: IProps) => { const { t } = useTranslation(); diff --git a/react/features/base/config/functions.web.ts b/react/features/base/config/functions.web.ts index 00f4ddb0cc..19f44701ef 100644 --- a/react/features/base/config/functions.web.ts +++ b/react/features/base/config/functions.web.ts @@ -66,8 +66,7 @@ export function getWebHIDFeatureConfig(state: IReduxState): boolean { /** * Checks if the specified button is enabled. * - * @param {string} buttonName - The name of the button. - * {@link interfaceConfig}. + * @param {string} buttonName - The name of the button. See {@link interfaceConfig}. * @param {Object|Array} state - The redux state or the array with the enabled buttons. * @returns {boolean} - True if the button is enabled and false otherwise. */ diff --git a/react/features/base/modal/components/functions.native.ts b/react/features/base/modal/components/functions.native.ts index 92730f7384..f3983858f0 100644 --- a/react/features/base/modal/components/functions.native.ts +++ b/react/features/base/modal/components/functions.native.ts @@ -8,7 +8,7 @@ import { toState } from '../../redux/functions'; * @param {(Function|Object)} stateful - The (whole) redux state, or redux's * {@code getState} function to be used to retrieve the state * features/base/config. - * @returns {number}. + * @returns {number} */ export function getClientWidth(stateful: IStateful) { const state = toState(stateful)['features/base/responsive-ui']; @@ -23,7 +23,7 @@ export function getClientWidth(stateful: IStateful) { * @param {(Function|Object)} stateful - The (whole) redux state, or redux's * {@code getState} function to be used to retrieve the state * features/base/config. - * @returns {number}. + * @returns {number} */ export function getClientHeight(stateful: IStateful) { const state = toState(stateful)['features/base/responsive-ui']; diff --git a/react/features/base/tooltip/actionTypes.tsx b/react/features/base/tooltip/actionTypes.ts similarity index 100% rename from react/features/base/tooltip/actionTypes.tsx rename to react/features/base/tooltip/actionTypes.ts diff --git a/react/features/base/util/helpers.ts b/react/features/base/util/helpers.ts index 270e287edf..b69362f2c3 100644 --- a/react/features/base/util/helpers.ts +++ b/react/features/base/util/helpers.ts @@ -145,7 +145,7 @@ export function setColorAlpha(color: string, opacity: number) { /** * Gets the hexa rgb values for a shorthand css color. * - * @param {string} color - + * @param {string} color - The shorthand css color. * @returns {Array} - Array containing parsed r, g, b values of the color. */ function parseShorthandColor(color: string) { diff --git a/react/features/chat/components/web/MessageContainer.tsx b/react/features/chat/components/web/MessageContainer.tsx index ccd38345ec..bbcd131ad0 100644 --- a/react/features/chat/components/web/MessageContainer.tsx +++ b/react/features/chat/components/web/MessageContainer.tsx @@ -295,7 +295,7 @@ export default class MessageContainer extends AbstractMessageContainer ((STORE_NAME, (state = DEFAULT_STA * Transforms the branding images into an array of Images objects ready * to be used as virtual backgrounds. * - * @param {Array} images - + * @param {Array} images - The branding images. * @private * @returns {{Props}} */ diff --git a/react/features/e2ee/functions.ts b/react/features/e2ee/functions.ts index 6bf6857f58..64a59cd674 100644 --- a/react/features/e2ee/functions.ts +++ b/react/features/e2ee/functions.ts @@ -50,7 +50,7 @@ export function doesEveryoneSupportE2EE(stateful: IStateful) { * * @param {Function|Object} stateful - The redux store or {@code getState} * function. - * @returns {boolean}. + * @returns {boolean} */ export function isMaxModeReached(stateful: IStateful) { const participantCount = getParticipantCount(toState(stateful)); @@ -63,7 +63,7 @@ export function isMaxModeReached(stateful: IStateful) { * * @param {Function|Object} stateful - The redux store or {@code getState} * function. - * @returns {boolean}. + * @returns {boolean} */ export function isMaxModeThresholdReached(stateful: IStateful) { const participantCount = getParticipantCount(toState(stateful)); diff --git a/react/features/filmstrip/components/native/Filmstrip.tsx b/react/features/filmstrip/components/native/Filmstrip.tsx index cdbc091710..6af180bb57 100644 --- a/react/features/filmstrip/components/native/Filmstrip.tsx +++ b/react/features/filmstrip/components/native/Filmstrip.tsx @@ -81,7 +81,7 @@ interface IProps { class Filmstrip extends PureComponent { /** * Whether the local participant should be rendered separately from the - * remote participants ie outside of their {@link ScrollView}. + * remote participants i.e. outside of their {@link ScrollView}. */ _separateLocalThumbnail: boolean; diff --git a/react/features/screenshot-capture/constants.ts b/react/features/screenshot-capture/constants.ts index dc847cb111..4bc2bc14c6 100644 --- a/react/features/screenshot-capture/constants.ts +++ b/react/features/screenshot-capture/constants.ts @@ -11,12 +11,15 @@ export const POLL_INTERVAL = 2000; /** * SET_TIMEOUT constant is used to set interval and it is set in * the id property of the request.data property. TimeMs property must - * also be set. Request.data example: + * also be set. * + * ``` + * Request.data example: * { * id: SET_TIMEOUT, * timeMs: 33 - * }. + * } + * ``` */ export const SET_TIMEOUT = 1; @@ -24,18 +27,22 @@ export const SET_TIMEOUT = 1; * CLEAR_TIMEOUT constant is used to clear the interval and it is set in * the id property of the request.data property. * + * ``` * { * id: CLEAR_TIMEOUT - * }. + * } + * ``` */ export const CLEAR_TIMEOUT = 2; /** * TIMEOUT_TICK constant is used as response and it is set in the id property. * + * ``` * { * id: TIMEOUT_TICK - * }. + * } + * ``` */ export const TIMEOUT_TICK = 3; diff --git a/react/features/settings/components/web/LogoutDialog.tsx b/react/features/settings/components/web/LogoutDialog.tsx index 05577a6f99..c2cbd8bb73 100644 --- a/react/features/settings/components/web/LogoutDialog.tsx +++ b/react/features/settings/components/web/LogoutDialog.tsx @@ -20,7 +20,7 @@ interface IProps extends WithTranslation { * Implements the Logout dialog. * * @param {Object} props - The props of the component. - * @returns {React$Element}. + * @returns {React$Element} */ function LogoutDialog({ onLogout, t }: IProps) { return ( diff --git a/react/features/stream-effects/virtual-background/TimerWorker.ts b/react/features/stream-effects/virtual-background/TimerWorker.ts index 741aa35941..b1008a7acb 100644 --- a/react/features/stream-effects/virtual-background/TimerWorker.ts +++ b/react/features/stream-effects/virtual-background/TimerWorker.ts @@ -2,12 +2,15 @@ /** * SET_TIMEOUT constant is used to set interval and it is set in * the id property of the request.data property. TimeMs property must - * also be set. Request.data example: + * also be set. * + * ``` + * //Request.data example: * { * id: SET_TIMEOUT, * timeMs: 33 - * }. + * } + * ``` */ export const SET_TIMEOUT = 1; @@ -15,18 +18,22 @@ export const SET_TIMEOUT = 1; * CLEAR_TIMEOUT constant is used to clear the interval and it is set in * the id property of the request.data property. * + * ``` * { * id: CLEAR_TIMEOUT - * }. + * } + * ``` */ export const CLEAR_TIMEOUT = 2; /** * TIMEOUT_TICK constant is used as response and it is set in the id property. * + * ``` * { * id: TIMEOUT_TICK - * }. + * } + * ``` */ export const TIMEOUT_TICK = 3; diff --git a/react/features/toolbox/components/native/Toolbox.tsx b/react/features/toolbox/components/native/Toolbox.tsx index 5f8ad9a521..c752d69bc0 100644 --- a/react/features/toolbox/components/native/Toolbox.tsx +++ b/react/features/toolbox/components/native/Toolbox.tsx @@ -62,7 +62,7 @@ interface IProps { * Implements the conference Toolbox on React Native. * * @param {Object} props - The props of the component. - * @returns {React$Element}. + * @returns {React$Element} */ function Toolbox(props: IProps) { const { _endConferenceSupported, _shouldDisplayReactionsButtons, _styles, _visible, _iAmVisitor, _width } = props; diff --git a/react/features/virtual-background/functions.ts b/react/features/virtual-background/functions.ts index 099ea04991..e67670e59c 100644 --- a/react/features/virtual-background/functions.ts +++ b/react/features/virtual-background/functions.ts @@ -65,7 +65,6 @@ export const toDataURL = async (url: string) => { * @param {number} width - Value for resizing the image width. * @param {number} height - Value for resizing the image height. * @returns {Promise} - * */ export function resizeImage(base64image: any, width = 1920, height = 1080): Promise { diff --git a/react/features/web-hid/webhid-manager.ts b/react/features/web-hid/webhid-manager.ts index 91de4a5675..4dc1471330 100644 --- a/react/features/web-hid/webhid-manager.ts +++ b/react/features/web-hid/webhid-manager.ts @@ -233,7 +233,7 @@ export default class WebHidManager extends EventTarget { /** * Close device and reset state. * - * @returns {void}. + * @returns {void} */ async close() { try {