@automattic/jetpack-boost-score-api 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.5] - 2023-07-17
+### Changed
+- Updated package dependencies. [#31815]
+
+## [0.1.4] - 2023-07-11
+### Changed
+- Updated package dependencies. [#31785]
+
+### Fixed
+- Fix type declarations for vars holding returns from `setTimeout`, `setInterval`. [#31769]
+
 ## [0.1.3] - 2023-07-05
 ### Changed
 - Updated package dependencies. [#31659]
@@ -24,6 +35,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Create package for the boost score bar API [#30781]
 
+[0.1.5]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.4...v0.1.5
+[0.1.4]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.3...v0.1.4
 [0.1.3]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.0...v0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-boost-score-api",
-	"version": "0.1.3",
+	"version": "0.1.5",
 	"description": "A package to get the Jetpack Boost score of a site",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/boost-score-api/#readme",
 	"bugs": {
@@ -20,13 +20,13 @@
 		"test": "jest tests"
 	},
 	"dependencies": {
-		"@wordpress/i18n": "4.36.0",
+		"@wordpress/i18n": "4.37.0",
 		"zod": "3.20.2"
 	},
 	"devDependencies": {
 		"@automattic/jetpack-webpack-config": "workspace:*",
-		"@typescript-eslint/parser": "5.59.0",
-		"eslint": "8.39.0",
+		"@typescript-eslint/parser": "5.62.0",
+		"eslint": "8.44.0",
 		"jest": "29.5.0",
 		"jest-environment-jsdom": "29.4.3",
 		"ts-loader": "9.4.2",

package/src/utils/poll-promise.ts

@@ -1,12 +1,12 @@
 import { __ } from '@wordpress/i18n';
 
-type Resolve< ReturnType = void > = ( value: ReturnType | PromiseLike< ReturnType > ) => void;
+type Resolve< RetType = void > = ( value: RetType | PromiseLike< RetType > ) => void;
 
-type PollPromiseArgs< ReturnType = void > = {
+type PollPromiseArgs< RetType = void > = {
 	interval: number;
 	timeout: number;
 	timeoutError?: string;
-	callback: ( resolve: Resolve< ReturnType > ) => Promise< void > | void;
+	callback: ( resolve: Resolve< RetType > ) => Promise< void > | void;
 };
 
 /**
@@ -16,23 +16,24 @@ type PollPromiseArgs< ReturnType = void > = {
  *
  * Rejects with a timeout after <timeout> milliseconds.
  *
- * @template ReturnType
+ * @template RetType
  * @param {object}   obj              - Arguments object.
  * @param {number}   obj.interval     - Milliseconds between calling callback
  * @param {number}   obj.timeout      - Milliseconds before rejecting w/ a timeout
  * @param {Function} obj.callback     - Callback to call every <interval> ms.
  * @param {string}   obj.timeoutError - Message to throw on timeout.
- * @returns {Promise< ReturnType >} - A promise which resolves to the value resolved() inside callback.
+ * @returns {Promise< RetType >} - A promise which resolves to the value resolved() inside callback.
  */
-export default async function pollPromise< ReturnType = void >( {
+export default async function pollPromise< RetType = void >( {
 	interval,
 	callback,
 	timeout,
 	timeoutError,
-}: PollPromiseArgs< ReturnType > ): Promise< ReturnType > {
-	let timeoutHandle: number, intervalHandle: number;
+}: PollPromiseArgs< RetType > ): Promise< RetType > {
+	let timeoutHandle: ReturnType< typeof setTimeout >,
+		intervalHandle: ReturnType< typeof setInterval >;
 
-	return new Promise< ReturnType >( ( resolve, reject ) => {
+	return new Promise< RetType >( ( resolve, reject ) => {
 		timeoutHandle = setTimeout( () => {
 			reject( new Error( timeoutError || __( 'Timed out', 'boost-score-api' ) ) );
 		}, timeout || 2 * 60 * 1000 );