chrome-types 0.1.142 → 0.1.144

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Tue Oct 25 2022 22:30:45 GMT+0000 (Coordinated Universal Time)
-// Built at 8c16cf9eed517a5c8c766b5347dac83cabba42d3
+// Generated on Thu Oct 27 2022 22:30:04 GMT+0000 (Coordinated Universal Time)
+// Built at e5a31326bad1d5e393ba0d753528e832bd4f9521
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -9579,7 +9579,7 @@ declare namespace chrome {
     }
 
     /**
-     * The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the [global rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-rule-limit).
+     * The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-static-rule-limit).
      *
      * @since Chrome 89
      */
@@ -9883,7 +9883,7 @@ declare namespace chrome {
     ): void;
 
     /**
-     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-rule-limit) is reached.
+     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-static-rule-limit) is reached.
      *
      * @chrome-returns-extra since Pending
      * @since Chrome 89
@@ -9891,7 +9891,7 @@ declare namespace chrome {
     export function getAvailableStaticRuleCount(): Promise<number>;
 
     /**
-     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-rule-limit) is reached.
+     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-static-rule-limit) is reached.
      *
      * @since Chrome 89
      */
@@ -23382,21 +23382,53 @@ declare namespace chrome {
      * **Important**: Most extensions/apps should **not** use this method, since Chrome already does automatic checks every few hours, and you can listen for the {@link runtime.onUpdateAvailable} event without needing to call requestUpdateCheck.
      *
      * This method is only appropriate to call in very limited circumstances, such as if your extension/app talks to a backend service, and the backend service has determined that the client extension/app version is very far out of date and you'd like to prompt a user to update. Most other uses of requestUpdateCheck, such as calling it unconditionally based on a repeating timer, probably only serve to waste client, network, and server resources.
+     *
+     * Note: When called with a callback, instead of returning an object this function will return the two properties as separate arguments passed to the callback.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function requestUpdateCheck(): Promise<{
+
+      /**
+       * Result of the update check.
+       */
+      status: RequestUpdateCheckStatus,
+
+      /**
+       * If an update is available, this contains the version of the available update.
+       */
+      version?: string,
+    }>;
+
+    /**
+     * Requests an immediate update check be done for this app/extension.
+     *
+     * **Important**: Most extensions/apps should **not** use this method, since Chrome already does automatic checks every few hours, and you can listen for the {@link runtime.onUpdateAvailable} event without needing to call requestUpdateCheck.
+     *
+     * This method is only appropriate to call in very limited circumstances, such as if your extension/app talks to a backend service, and the backend service has determined that the client extension/app version is very far out of date and you'd like to prompt a user to update. Most other uses of requestUpdateCheck, such as calling it unconditionally based on a repeating timer, probably only serve to waste client, network, and server resources.
+     *
+     * Note: When called with a callback, instead of returning an object this function will return the two properties as separate arguments passed to the callback.
      */
     export function requestUpdateCheck(
 
       /**
-       * @param status Result of the update check.
-       * @param details If an update is available, this contains more information about the available update.
+       * @param result RequestUpdateCheckResult object that holds the status of the update check and any details of the result if there is an update available
        */
-      callback: (
-        status: RequestUpdateCheckStatus,
-        details?: {
+      callback?: (
+        /**
+         * @since Pending
+         */
+        result: {
+
+          /**
+           * Result of the update check.
+           */
+          status: RequestUpdateCheckStatus,
 
           /**
-           * The version of the available update.
+           * If an update is available, this contains the version of the available update.
            */
-          version: string,
+          version?: string,
         },
       ) => void,
     ): void;

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Tue Oct 25 2022 22:30:40 GMT+0000 (Coordinated Universal Time)
-// Built at 8c16cf9eed517a5c8c766b5347dac83cabba42d3
+// Generated on Thu Oct 27 2022 22:29:59 GMT+0000 (Coordinated Universal Time)
+// Built at e5a31326bad1d5e393ba0d753528e832bd4f9521
 
 // Includes MV3+ APIs only.
 
@@ -6381,7 +6381,7 @@ declare namespace chrome {
     }
 
     /**
-     * The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the [global rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-rule-limit).
+     * The minimum number of static rules guaranteed to an extension across its enabled static rulesets. Any rules above this limit will count towards the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-static-rule-limit).
      *
      * @since Chrome 89
      */
@@ -6685,7 +6685,7 @@ declare namespace chrome {
     ): void;
 
     /**
-     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-rule-limit) is reached.
+     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-static-rule-limit) is reached.
      *
      * @chrome-returns-extra since Pending
      * @since Chrome 89
@@ -6693,7 +6693,7 @@ declare namespace chrome {
     export function getAvailableStaticRuleCount(): Promise<number>;
 
     /**
-     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-rule-limit) is reached.
+     * Returns the number of static rules an extension can enable before the [global static rule limit](https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#global-static-rule-limit) is reached.
      *
      * @since Chrome 89
      */
@@ -18252,21 +18252,53 @@ declare namespace chrome {
      * **Important**: Most extensions/apps should **not** use this method, since Chrome already does automatic checks every few hours, and you can listen for the {@link runtime.onUpdateAvailable} event without needing to call requestUpdateCheck.
      *
      * This method is only appropriate to call in very limited circumstances, such as if your extension/app talks to a backend service, and the backend service has determined that the client extension/app version is very far out of date and you'd like to prompt a user to update. Most other uses of requestUpdateCheck, such as calling it unconditionally based on a repeating timer, probably only serve to waste client, network, and server resources.
+     *
+     * Note: When called with a callback, instead of returning an object this function will return the two properties as separate arguments passed to the callback.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function requestUpdateCheck(): Promise<{
+
+      /**
+       * Result of the update check.
+       */
+      status: RequestUpdateCheckStatus,
+
+      /**
+       * If an update is available, this contains the version of the available update.
+       */
+      version?: string,
+    }>;
+
+    /**
+     * Requests an immediate update check be done for this app/extension.
+     *
+     * **Important**: Most extensions/apps should **not** use this method, since Chrome already does automatic checks every few hours, and you can listen for the {@link runtime.onUpdateAvailable} event without needing to call requestUpdateCheck.
+     *
+     * This method is only appropriate to call in very limited circumstances, such as if your extension/app talks to a backend service, and the backend service has determined that the client extension/app version is very far out of date and you'd like to prompt a user to update. Most other uses of requestUpdateCheck, such as calling it unconditionally based on a repeating timer, probably only serve to waste client, network, and server resources.
+     *
+     * Note: When called with a callback, instead of returning an object this function will return the two properties as separate arguments passed to the callback.
      */
     export function requestUpdateCheck(
 
       /**
-       * @param status Result of the update check.
-       * @param details If an update is available, this contains more information about the available update.
+       * @param result RequestUpdateCheckResult object that holds the status of the update check and any details of the result if there is an update available
        */
-      callback: (
-        status: RequestUpdateCheckStatus,
-        details?: {
+      callback?: (
+        /**
+         * @since Pending
+         */
+        result: {
+
+          /**
+           * Result of the update check.
+           */
+          status: RequestUpdateCheckStatus,
 
           /**
-           * The version of the available update.
+           * If an update is available, this contains the version of the available update.
            */
-          version: string,
+          version?: string,
         },
       ) => void,
     ): void;

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "1549f818859300d7"
+    "build-hash": "a70e8bfc1fbee2b5"
   },
   "repository": {
     "type": "git",
@@ -16,5 +16,5 @@
     "url": "https://github.com/GoogleChrome/chrome-types/issues"
   },
   "homepage": "https://github.com/GoogleChrome/chrome-types",
-  "version": "0.1.142"
+  "version": "0.1.144"
 }