node-simctl - npm Package Compare versions

Comparing version 7.5.5 to 7.6.0

build/lib/simctl.d.ts

@@ -42,2 +42,8 @@ export default Simctl;
     architectures?: string | string[] | undefined;
+    /**
+     * - The maximum number of milliseconds
+     * to wait for single synchronous xcrun command. If not provided explicitly, then
+     * the value of execTimeout property is used by default.
+     */
+    timeout?: number | undefined;
 };
@@ -54,3 +60,3 @@ export type SimctlOpts = {
     /**
-     * - The maximum number of milliseconds
+     * - The default maximum number of milliseconds
      * to wait for single synchronous xcrun command.
@@ -98,2 +104,5 @@ */
  * executing xcrun. See https://github.com/appium/appium/issues/18966 for more details.
+ * @property {number} [timeout] - The maximum number of milliseconds
+ * to wait for single synchronous xcrun command. If not provided explicitly, then
+ * the value of execTimeout property is used by default.
  */
@@ -107,3 +116,3 @@ /**
  * then it is going to be used by `exec` and no autodetection will happen.
- * @property {number} [execTimeout=600000] - The maximum number of milliseconds
+ * @property {number} [execTimeout=600000] - The default maximum number of milliseconds
  * to wait for single synchronous xcrun command.
@@ -110,0 +119,0 @@ * @property {boolean} [logErrors=true] - Whether to wire xcrun error messages

build/lib/simctl.js

@@ -89,2 +89,5 @@ "use strict";
  * executing xcrun. See https://github.com/appium/appium/issues/18966 for more details.
+ * @property {number} [timeout] - The maximum number of milliseconds
+ * to wait for single synchronous xcrun command. If not provided explicitly, then
+ * the value of execTimeout property is used by default.
  */
@@ -98,3 +101,3 @@ /**
  * then it is going to be used by `exec` and no autodetection will happen.
- * @property {number} [execTimeout=600000] - The maximum number of milliseconds
+ * @property {number} [execTimeout=600000] - The default maximum number of milliseconds
  * to wait for single synchronous xcrun command.
@@ -214,3 +217,3 @@ * @property {boolean} [logErrors=true] - Whether to wire xcrun error messages
     async exec(subcommand, opts) {
-        let { args = [], env = {}, asynchronous = false, encoding, logErrors = true, architectures, } = opts ?? {};
+        let { args = [], env = {}, asynchronous = false, encoding, logErrors = true, architectures, timeout, } = opts ?? {};
         // run a particular simctl command
@@ -231,3 +234,3 @@ args = [
         if (!asynchronous) {
-            execOpts.timeout = this.execTimeout;
+            execOpts.timeout = timeout || this.execTimeout;
         }
@@ -234,0 +237,0 @@ const xcrun = await this.requireXcrun();

CHANGELOG.md

@@ -0,1 +1,7 @@
+## [7.6.0](https://github.com/appium/node-simctl/compare/v7.5.5...v7.6.0) (2024-08-31)
+
+### Features
+
+* add timeout option for exec ([#254](https://github.com/appium/node-simctl/issues/254)) ([1c2e1d8](https://github.com/appium/node-simctl/commit/1c2e1d829815f1e465c0497b0e87914e56222e8e))
+
 ## [7.5.5](https://github.com/appium/node-simctl/compare/v7.5.4...v7.5.5) (2024-08-29)
@@ -2,0 +8,0 @@

lib/simctl.js

@@ -66,2 +66,5 @@ import _ from 'lodash';
  * executing xcrun. See https://github.com/appium/appium/issues/18966 for more details.
+ * @property {number} [timeout] - The maximum number of milliseconds
+ * to wait for single synchronous xcrun command. If not provided explicitly, then
+ * the value of execTimeout property is used by default.
  */
@@ -76,3 +79,3 @@
  * then it is going to be used by `exec` and no autodetection will happen.
- * @property {number} [execTimeout=600000] - The maximum number of milliseconds
+ * @property {number} [execTimeout=600000] - The default maximum number of milliseconds
  * to wait for single synchronous xcrun command.
@@ -180,2 +183,3 @@ * @property {boolean} [logErrors=true] - Whether to wire xcrun error messages
       architectures,
+      timeout,
     } = opts ?? {};
@@ -202,3 +206,3 @@ // run a particular simctl command
     if (!asynchronous) {
-      execOpts.timeout = this.execTimeout;
+      execOpts.timeout = timeout || this.execTimeout;
     }
@@ -205,0 +209,0 @@ const xcrun = await this.requireXcrun();

package.json

@@ -9,3 +9,3 @@ {
   ],
-  "version": "7.5.5",
+  "version": "7.6.0",
   "author": "Appium Contributors",
@@ -12,0 +12,0 @@ "license": "Apache-2.0",

No alert changes

Improved metrics

Total package byte prevSize

244921

0.52%

Lines of code

4150

0.39%

No dependency changes