chrome-types 0.1.364 → 0.1.365

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Thu Jul 24 2025 22:33:54 GMT+0000 (Coordinated Universal Time)
-// Built at 16aab40117a3dacc9393cd3dd389e556ab3659c8
+// Generated on Fri Jul 25 2025 10:14:07 GMT+0000 (Coordinated Universal Time)
+// Built at f140a2e2a376335e7d3d1b341e99a78a63272e04
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -726,6 +726,217 @@ declare namespace chrome {
     ): void;
   }
 
+  /**
+   * Use the `chrome.alarms` API to schedule code to run periodically or at a specified time in the future.
+   *
+   * @chrome-permission alarms
+   */
+  export namespace alarms {
+
+    export interface Alarm {
+
+      /**
+       * Name of this alarm.
+       */
+      name: string;
+
+      /**
+       * Time at which this alarm was scheduled to fire, in milliseconds past the epoch (e.g. `Date.now() + n`). For performance reasons, the alarm may have been delayed an arbitrary amount beyond this.
+       */
+      scheduledTime: number;
+
+      /**
+       * If not null, the alarm is a repeating alarm and will fire again in `periodInMinutes` minutes.
+       */
+      periodInMinutes?: number;
+    }
+
+    export interface AlarmCreateInfo {
+
+      /**
+       * Time at which the alarm should fire, in milliseconds past the epoch (e.g. `Date.now() + n`).
+       */
+      when?: number;
+
+      /**
+       * Length of time in minutes after which the `onAlarm` event should fire.
+       */
+      delayInMinutes?: number;
+
+      /**
+       * If set, the onAlarm event should fire every `periodInMinutes` minutes after the initial event specified by `when` or `delayInMinutes`. If not set, the alarm will only fire once.
+       */
+      periodInMinutes?: number;
+    }
+
+    /**
+     * Fired when an alarm has elapsed. Useful for event pages.
+     */
+    export const onAlarm: events.Event<(
+      alarm: Alarm,
+    ) => void>;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @chrome-returns-extra since Chrome 111
+     * @param name Optional name to identify this alarm. Defaults to the empty string.
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     */
+    export function create(
+
+      name: string,
+
+      alarmInfo: AlarmCreateInfo,
+    ): Promise<void>;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @chrome-returns-extra since Chrome 111
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     */
+    export function create(
+
+      alarmInfo: AlarmCreateInfo,
+    ): Promise<void>;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @param name Optional name to identify this alarm. Defaults to the empty string.
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     * @param callback Invoked when the alarm has been created.
+     */
+    export function create(
+
+      name: string,
+
+      alarmInfo: AlarmCreateInfo,
+
+      /**
+       * @since Chrome 111
+       */
+      callback?: () => void,
+    ): void;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     * @param callback Invoked when the alarm has been created.
+     */
+    export function create(
+
+      alarmInfo: AlarmCreateInfo,
+
+      /**
+       * @since Chrome 111
+       */
+      callback?: () => void,
+    ): void;
+
+    /**
+     * Retrieves details about the specified alarm.
+     *
+     * @chrome-returns-extra since Chrome 91
+     * @param name The name of the alarm to get. Defaults to the empty string.
+     */
+    export function get(
+
+      name?: string,
+    ): Promise<Alarm | undefined>;
+
+    /**
+     * Retrieves details about the specified alarm.
+     *
+     * @param name The name of the alarm to get. Defaults to the empty string.
+     */
+    export function get(
+
+      name?: string,
+
+      callback?: (
+        alarm?: Alarm,
+      ) => void,
+    ): void;
+
+    /**
+     * Gets an array of all the alarms.
+     *
+     * @chrome-returns-extra since Chrome 91
+     */
+    export function getAll(): Promise<Alarm[]>;
+
+    /**
+     * Gets an array of all the alarms.
+     */
+    export function getAll(
+
+      callback?: (
+        alarms: Alarm[],
+      ) => void,
+    ): void;
+
+    /**
+     * Clears the alarm with the given name.
+     *
+     * @chrome-returns-extra since Chrome 91
+     * @param name The name of the alarm to clear. Defaults to the empty string.
+     */
+    export function clear(
+
+      name?: string,
+    ): Promise<boolean>;
+
+    /**
+     * Clears the alarm with the given name.
+     *
+     * @param name The name of the alarm to clear. Defaults to the empty string.
+     */
+    export function clear(
+
+      name?: string,
+
+      callback?: (
+        wasCleared: boolean,
+      ) => void,
+    ): void;
+
+    /**
+     * Clears all alarms.
+     *
+     * @chrome-returns-extra since Chrome 91
+     */
+    export function clearAll(): Promise<boolean>;
+
+    /**
+     * Clears all alarms.
+     */
+    export function clearAll(
+
+      callback?: (
+        wasCleared: boolean,
+      ) => void,
+    ): void;
+  }
+
   /**
    * @chrome-disallow-service-workers
    * @chrome-max-manifest MV2
@@ -31627,7 +31838,7 @@ declare namespace chrome {
         groupId?: number,
 
         /**
-         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_TAB_ID_NONE} for tabs that aren't in a Split View.
+         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_VIEW_ID_NONE} for tabs that aren't in a Split View.
          *
          * @since Pending
          */
@@ -31740,7 +31951,7 @@ declare namespace chrome {
         groupId?: number,
 
         /**
-         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_TAB_ID_NONE} for tabs that aren't in a Split View.
+         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_VIEW_ID_NONE} for tabs that aren't in a Split View.
          *
          * @since Pending
          */

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Thu Jul 24 2025 22:33:49 GMT+0000 (Coordinated Universal Time)
-// Built at 16aab40117a3dacc9393cd3dd389e556ab3659c8
+// Generated on Fri Jul 25 2025 10:14:03 GMT+0000 (Coordinated Universal Time)
+// Built at f140a2e2a376335e7d3d1b341e99a78a63272e04
 
 // Includes MV3+ APIs only.
 
@@ -784,6 +784,217 @@ declare namespace chrome {
     ): void;
   }
 
+  /**
+   * Use the `chrome.alarms` API to schedule code to run periodically or at a specified time in the future.
+   *
+   * @chrome-permission alarms
+   */
+  export namespace alarms {
+
+    export interface Alarm {
+
+      /**
+       * Name of this alarm.
+       */
+      name: string;
+
+      /**
+       * Time at which this alarm was scheduled to fire, in milliseconds past the epoch (e.g. `Date.now() + n`). For performance reasons, the alarm may have been delayed an arbitrary amount beyond this.
+       */
+      scheduledTime: number;
+
+      /**
+       * If not null, the alarm is a repeating alarm and will fire again in `periodInMinutes` minutes.
+       */
+      periodInMinutes?: number;
+    }
+
+    export interface AlarmCreateInfo {
+
+      /**
+       * Time at which the alarm should fire, in milliseconds past the epoch (e.g. `Date.now() + n`).
+       */
+      when?: number;
+
+      /**
+       * Length of time in minutes after which the `onAlarm` event should fire.
+       */
+      delayInMinutes?: number;
+
+      /**
+       * If set, the onAlarm event should fire every `periodInMinutes` minutes after the initial event specified by `when` or `delayInMinutes`. If not set, the alarm will only fire once.
+       */
+      periodInMinutes?: number;
+    }
+
+    /**
+     * Fired when an alarm has elapsed. Useful for event pages.
+     */
+    export const onAlarm: events.Event<(
+      alarm: Alarm,
+    ) => void>;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @chrome-returns-extra since Chrome 111
+     * @param name Optional name to identify this alarm. Defaults to the empty string.
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     */
+    export function create(
+
+      name: string,
+
+      alarmInfo: AlarmCreateInfo,
+    ): Promise<void>;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @chrome-returns-extra since Chrome 111
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     */
+    export function create(
+
+      alarmInfo: AlarmCreateInfo,
+    ): Promise<void>;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @param name Optional name to identify this alarm. Defaults to the empty string.
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     * @param callback Invoked when the alarm has been created.
+     */
+    export function create(
+
+      name: string,
+
+      alarmInfo: AlarmCreateInfo,
+
+      /**
+       * @since Chrome 111
+       */
+      callback?: () => void,
+    ): void;
+
+    /**
+     * Creates an alarm. Near the time(s) specified by `alarmInfo`, the `onAlarm` event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.
+     *
+     * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 30 seconds but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `0.5` will not be honored and will cause a warning. `when` can be set to less than 30 seconds after "now" without warning but won't actually cause the alarm to fire for at least 30 seconds.
+     *
+     * To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.
+     *
+     * @param alarmInfo Describes when the alarm should fire. The initial time must be specified by either `when` or `delayInMinutes` (but not both). If `periodInMinutes` is set, the alarm will repeat every `periodInMinutes` minutes after the initial event. If neither `when` or `delayInMinutes` is set for a repeating alarm, `periodInMinutes` is used as the default for `delayInMinutes`.
+     * @param callback Invoked when the alarm has been created.
+     */
+    export function create(
+
+      alarmInfo: AlarmCreateInfo,
+
+      /**
+       * @since Chrome 111
+       */
+      callback?: () => void,
+    ): void;
+
+    /**
+     * Retrieves details about the specified alarm.
+     *
+     * @chrome-returns-extra since Chrome 91
+     * @param name The name of the alarm to get. Defaults to the empty string.
+     */
+    export function get(
+
+      name?: string,
+    ): Promise<Alarm | undefined>;
+
+    /**
+     * Retrieves details about the specified alarm.
+     *
+     * @param name The name of the alarm to get. Defaults to the empty string.
+     */
+    export function get(
+
+      name?: string,
+
+      callback?: (
+        alarm?: Alarm,
+      ) => void,
+    ): void;
+
+    /**
+     * Gets an array of all the alarms.
+     *
+     * @chrome-returns-extra since Chrome 91
+     */
+    export function getAll(): Promise<Alarm[]>;
+
+    /**
+     * Gets an array of all the alarms.
+     */
+    export function getAll(
+
+      callback?: (
+        alarms: Alarm[],
+      ) => void,
+    ): void;
+
+    /**
+     * Clears the alarm with the given name.
+     *
+     * @chrome-returns-extra since Chrome 91
+     * @param name The name of the alarm to clear. Defaults to the empty string.
+     */
+    export function clear(
+
+      name?: string,
+    ): Promise<boolean>;
+
+    /**
+     * Clears the alarm with the given name.
+     *
+     * @param name The name of the alarm to clear. Defaults to the empty string.
+     */
+    export function clear(
+
+      name?: string,
+
+      callback?: (
+        wasCleared: boolean,
+      ) => void,
+    ): void;
+
+    /**
+     * Clears all alarms.
+     *
+     * @chrome-returns-extra since Chrome 91
+     */
+    export function clearAll(): Promise<boolean>;
+
+    /**
+     * Clears all alarms.
+     */
+    export function clearAll(
+
+      callback?: (
+        wasCleared: boolean,
+      ) => void,
+    ): void;
+  }
+
   /**
    * The `chrome.audio` API is provided to allow users to get information about and control the audio devices attached to the system. This API is currently only available in kiosk mode for ChromeOS.
    *
@@ -24666,7 +24877,7 @@ declare namespace chrome {
         groupId?: number,
 
         /**
-         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_TAB_ID_NONE} for tabs that aren't in a Split View.
+         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_VIEW_ID_NONE} for tabs that aren't in a Split View.
          *
          * @since Pending
          */
@@ -24779,7 +24990,7 @@ declare namespace chrome {
         groupId?: number,
 
         /**
-         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_TAB_ID_NONE} for tabs that aren't in a Split View.
+         * The ID of the Split View that the tabs are in, or {@link tabs.SPLIT_VIEW_ID_NONE} for tabs that aren't in a Split View.
          *
          * @since Pending
          */

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "4ac966aa8337ec1d"
+    "build-hash": "0cd8a45b28a2c2ec"
   },
   "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.364"
+  "version": "0.1.365"
 }