Update JSDocs

cssnr · Jul 21, 2024 · cbb0592 · cbb0592
1 parent ac06e48
commit cbb0592
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 20 deletions.
diff --git a/src/js/exports.js b/src/js/exports.js
@@ -257,7 +257,7 @@ export function textFileDownload(filename, text) {
 /**
  * Request Host Permissions
  * @function requestPerms
- * @return {chrome.permissions.request}
+ * @return {Promise<*|chrome.permissions.request>}
  */
 export async function requestPerms() {
     return await chrome.permissions.request({
@@ -268,7 +268,7 @@ export async function requestPerms() {
 /**
  * Check Host Permissions
  * @function checkPerms
- * @return {Boolean}
+ * @return {Promise<*|Boolean>}
  */
 export async function checkPerms() {
     const hasPerms = await chrome.permissions.contains({

diff --git a/src/js/options.js b/src/js/options.js
@@ -345,7 +345,7 @@ async function filterClick(event) {
  * @function saveEditing
  * @param {MouseEvent} event
  * @param {String} idx
- * @return {Boolean}
+ * @return {Promise<*|Boolean>}
  */
 async function saveEditing(event, idx) {
     event.preventDefault() // block dragStart if editing

diff --git a/src/js/popup.js b/src/js/popup.js
@@ -234,12 +234,11 @@ function extractURLs(text) {
 
 /**
  * Grant Permissions Click Callback
- * Promise from requestPerms is ignored so we can close the popup immediately
  * @function grantPerms
  * @param {MouseEvent} event
  */
 export async function grantPerms(event) {
     console.debug('grantPerms:', event)
-    requestPerms()
+    requestPerms() // promise ignored so we can call window.close()
     window.close()
 }
diff --git a/src/js/service-worker.js b/src/js/service-worker.js
@@ -41,20 +41,18 @@ async function onInstalled(details) {
     const githubURL = 'https://github.com/cssnr/link-extractor'
     const installURL = 'https://link-extractor.cssnr.com/docs/?install=new'
     const uninstallURL = new URL('https://link-extractor.cssnr.com/uninstall/')
-    const { options, patterns } = await Promise.resolve(
-        setDefaultOptions({
-            linksDisplay: -1,
-            flags: 'ig',
-            lazyLoad: true,
-            removeDuplicates: true,
-            defaultFilter: true,
-            saveState: true,
-            linksTruncate: true,
-            linksNoWrap: false,
-            contextMenu: true,
-            showUpdate: false,
-        })
-    )
+    const { options, patterns } = await setDefaultOptions({
+        linksDisplay: -1,
+        flags: 'ig',
+        lazyLoad: true,
+        removeDuplicates: true,
+        defaultFilter: true,
+        saveState: true,
+        linksTruncate: true,
+        linksNoWrap: false,
+        contextMenu: true,
+        showUpdate: false,
+    })
     console.log('options, patterns:', options, patterns)
     if (options.contextMenu) {
         createContextMenus(patterns)
@@ -321,7 +319,7 @@ async function injectFunction(func, args) {
  * Set Default Options
  * @function setDefaultOptions
  * @param {Object} defaultOptions
- * @return {Object}
+ * @return {Promise<*|Object>}
  */
 async function setDefaultOptions(defaultOptions) {
     console.log('setDefaultOptions', defaultOptions)