chrome-types 0.1.159 → 0.1.160

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/_all.d.ts +47 -2
  2. package/index.d.ts +47 -2
  3. package/package.json +2 -2
package/_all.d.ts CHANGED
@@ -14,8 +14,8 @@
14
14
  * limitations under the License.
15
15
  */
16
16
 
17
- // Generated on Sun Jan 01 2023 22:30:30 GMT+0000 (Coordinated Universal Time)
18
- // Built at 8ff5f9bc7fe91c339d6ea5c097504f609a581b1a
17
+ // Generated on Fri Jan 06 2023 22:29:10 GMT+0000 (Coordinated Universal Time)
18
+ // Built at b40b7b69d17ea79dbc657f16b03df9cf5b276c9c
19
19
 
20
20
  // Includes all types, including MV2 + Platform Apps APIs.
21
21
 
@@ -780,6 +780,7 @@ declare namespace chrome {
780
780
  *
781
781
  * 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.
782
782
  *
783
+ * @chrome-returns-extra since Pending
783
784
  * @param name Optional name to identify this alarm. Defaults to the empty string.
784
785
  * @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`.
785
786
  */
@@ -788,6 +789,44 @@ declare namespace chrome {
788
789
  name: string,
789
790
 
790
791
  alarmInfo: AlarmCreateInfo,
792
+ ): Promise<void>;
793
+
794
+ /**
795
+ * 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.
796
+ *
797
+ * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `1` will not be honored and will cause a warning. `when` can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.
798
+ *
799
+ * 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.
800
+ *
801
+ * @chrome-returns-extra since Pending
802
+ * @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`.
803
+ */
804
+ export function create(
805
+
806
+ alarmInfo: AlarmCreateInfo,
807
+ ): Promise<void>;
808
+
809
+ /**
810
+ * 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.
811
+ *
812
+ * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `1` will not be honored and will cause a warning. `when` can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.
813
+ *
814
+ * 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.
815
+ *
816
+ * @param name Optional name to identify this alarm. Defaults to the empty string.
817
+ * @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`.
818
+ * @param callback Invoked when the alarm has been created.
819
+ */
820
+ export function create(
821
+
822
+ name: string,
823
+
824
+ alarmInfo: AlarmCreateInfo,
825
+
826
+ /**
827
+ * @since Pending
828
+ */
829
+ callback?: () => void,
791
830
  ): void;
792
831
 
793
832
  /**
@@ -798,10 +837,16 @@ declare namespace chrome {
798
837
  * 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.
799
838
  *
800
839
  * @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`.
840
+ * @param callback Invoked when the alarm has been created.
801
841
  */
802
842
  export function create(
803
843
 
804
844
  alarmInfo: AlarmCreateInfo,
845
+
846
+ /**
847
+ * @since Pending
848
+ */
849
+ callback?: () => void,
805
850
  ): void;
806
851
 
807
852
  /**
package/index.d.ts CHANGED
@@ -14,8 +14,8 @@
14
14
  * limitations under the License.
15
15
  */
16
16
 
17
- // Generated on Sun Jan 01 2023 22:30:24 GMT+0000 (Coordinated Universal Time)
18
- // Built at 8ff5f9bc7fe91c339d6ea5c097504f609a581b1a
17
+ // Generated on Fri Jan 06 2023 22:29:03 GMT+0000 (Coordinated Universal Time)
18
+ // Built at b40b7b69d17ea79dbc657f16b03df9cf5b276c9c
19
19
 
20
20
  // Includes MV3+ APIs only.
21
21
 
@@ -838,6 +838,7 @@ declare namespace chrome {
838
838
  *
839
839
  * 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.
840
840
  *
841
+ * @chrome-returns-extra since Pending
841
842
  * @param name Optional name to identify this alarm. Defaults to the empty string.
842
843
  * @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`.
843
844
  */
@@ -846,6 +847,44 @@ declare namespace chrome {
846
847
  name: string,
847
848
 
848
849
  alarmInfo: AlarmCreateInfo,
850
+ ): Promise<void>;
851
+
852
+ /**
853
+ * 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.
854
+ *
855
+ * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `1` will not be honored and will cause a warning. `when` can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.
856
+ *
857
+ * 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.
858
+ *
859
+ * @chrome-returns-extra since Pending
860
+ * @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`.
861
+ */
862
+ export function create(
863
+
864
+ alarmInfo: AlarmCreateInfo,
865
+ ): Promise<void>;
866
+
867
+ /**
868
+ * 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.
869
+ *
870
+ * In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting `delayInMinutes` or `periodInMinutes` to less than `1` will not be honored and will cause a warning. `when` can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.
871
+ *
872
+ * 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.
873
+ *
874
+ * @param name Optional name to identify this alarm. Defaults to the empty string.
875
+ * @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`.
876
+ * @param callback Invoked when the alarm has been created.
877
+ */
878
+ export function create(
879
+
880
+ name: string,
881
+
882
+ alarmInfo: AlarmCreateInfo,
883
+
884
+ /**
885
+ * @since Pending
886
+ */
887
+ callback?: () => void,
849
888
  ): void;
850
889
 
851
890
  /**
@@ -856,10 +895,16 @@ declare namespace chrome {
856
895
  * 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.
857
896
  *
858
897
  * @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`.
898
+ * @param callback Invoked when the alarm has been created.
859
899
  */
860
900
  export function create(
861
901
 
862
902
  alarmInfo: AlarmCreateInfo,
903
+
904
+ /**
905
+ * @since Pending
906
+ */
907
+ callback?: () => void,
863
908
  ): void;
864
909
 
865
910
  /**
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "type": "module",
6
6
  "name": "chrome-types",
7
7
  "config": {
8
- "build-hash": "1fadc35871b5f74d"
8
+ "build-hash": "27a3a724b0fc5542"
9
9
  },
10
10
  "repository": {
11
11
  "type": "git",
@@ -16,5 +16,5 @@
16
16
  "url": "https://github.com/GoogleChrome/chrome-types/issues"
17
17
  },
18
18
  "homepage": "https://github.com/GoogleChrome/chrome-types",
19
- "version": "0.1.159"
19
+ "version": "0.1.160"
20
20
  }