node-simctl 7.3.3 → 7.3.5

package/build/lib/subcommands/keychain.d.ts

@@ -1,16 +1,16 @@
 export default commands;
 export type CertOptions = {
     /**
-     * [false] - whether the `cert` argument
+     * - whether the `cert` argument
      * is the path to the certificate on the local file system or
      * a raw certificate content
      */
-    raw: boolean;
+    raw?: boolean | undefined;
 };
 declare namespace commands {
     /**
      * @typedef {Object} CertOptions
-     * @property {boolean} raw [false] - whether the `cert` argument
+     * @property {boolean} [raw=false] - whether the `cert` argument
      * is the path to the certificate on the local file system or
      * a raw certificate content
      */
@@ -21,12 +21,12 @@ declare namespace commands {
      * @param {string} cert the full path to a valid .cert file containing
      * the certificate content or the certificate content itself, depending on
      * options
-     * @param {Partial<CertOptions>} opts
+     * @param {CertOptions} [opts={}]
      * @throws {Error} if the current SDK version does not support the command
      * or there was an error while adding the certificate
      * @throws {Error} If the `udid` instance property is unset
      */
-    function addRootCertificate(cert: string, opts?: Partial<CertOptions>): Promise<void>;
+    function addRootCertificate(cert: string, opts?: CertOptions | undefined): Promise<void>;
     /**
      * Adds the given certificate to the Keychain Store on the simulator
      *
@@ -34,12 +34,12 @@ declare namespace commands {
      * @param {string} cert the full path to a valid .cert file containing
      * the certificate content or the certificate content itself, depending on
      * options
-     * @param {Partial<CertOptions>} opts
+     * @param {CertOptions} [opts={}]
      * @throws {Error} if the current SDK version does not support the command
      * or there was an error while adding the certificate
      * @throws {Error} If the `udid` instance property is unset
      */
-    function addCertificate(cert: string, opts?: Partial<CertOptions>): Promise<void>;
+    function addCertificate(cert: string, opts?: CertOptions | undefined): Promise<void>;
     /**
      * Resets the simulator keychain
      *

package/build/lib/subcommands/keychain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keychain.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/keychain.js"],"names":[],"mappings":";;;;;;;SA0Bc,OAAO;;;IAFrB;;;;;OAKG;IAEH;;;;;;;;;;;OAWG;IACH,sFAYC;IAED;;;;;;;;;;;OAWG;IACH,kFAYC;IAED;;;;;;;OAOG;IACH,wCAIC"}
+{"version":3,"file":"keychain.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/keychain.js"],"names":[],"mappings":";;;;;;;;;;IAwBA;;;;;OAKG;IAEH;;;;;;;;;;;OAWG;IACH,yFAYC;IAED;;;;;;;;;;;OAWG;IACH,qFAYC;IAED;;;;;;;OAOG;IACH,wCAIC"}

package/build/lib/subcommands/keychain.js

@@ -27,7 +27,7 @@ async function handleRawPayload(payload, onPayloadStored) {
 }
 /**
  * @typedef {Object} CertOptions
- * @property {boolean} raw [false] - whether the `cert` argument
+ * @property {boolean} [raw=false] - whether the `cert` argument
  * is the path to the certificate on the local file system or
  * a raw certificate content
  */
@@ -38,7 +38,7 @@ async function handleRawPayload(payload, onPayloadStored) {
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
- * @param {Partial<CertOptions>} opts
+ * @param {CertOptions} [opts={}]
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while adding the certificate
  * @throws {Error} If the `udid` instance property is unset
@@ -62,7 +62,7 @@ commands.addRootCertificate = async function addRootCertificate(cert, opts = {})
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
- * @param {Partial<CertOptions>} opts
+ * @param {CertOptions} [opts={}]
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while adding the certificate
  * @throws {Error} If the `udid` instance property is unset

package/build/lib/subcommands/launch.d.ts

@@ -7,13 +7,13 @@ declare namespace commands {
      *
      * @param {string} bundleId - Bundle identifier of the application,
      *                            which is going to be removed.
-     * @param {number} tries [5] - The maximum number of retries before
+     * @param {number} [tries=5] - The maximum number of retries before
      *                             throwing an exception.
      * @return {Promise<string>} the actual command output
      * @throws {Error} If the corresponding simctl subcommand command
      *                 returns non-zero return code.
      * @throws {Error} If the `udid` instance property is unset
      */
-    function launchApp(bundleId: string, tries?: number): Promise<string>;
+    function launchApp(bundleId: string, tries?: number | undefined): Promise<string>;
 }
 //# sourceMappingURL=launch.d.ts.map

package/build/lib/subcommands/launch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launch.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/launch.js"],"names":[],"mappings":";;IAKA;;;;;;;;;;;;;OAaG;IACH,sEAQC"}
+{"version":3,"file":"launch.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/launch.js"],"names":[],"mappings":";;IAKA;;;;;;;;;;;;;OAaG;IACH,kFAQC"}

package/build/lib/subcommands/launch.js

@@ -13,7 +13,7 @@ const commands = {};
  *
  * @param {string} bundleId - Bundle identifier of the application,
  *                            which is going to be removed.
- * @param {number} tries [5] - The maximum number of retries before
+ * @param {number} [tries=5] - The maximum number of retries before
  *                             throwing an exception.
  * @return {Promise<string>} the actual command output
  * @throws {Error} If the corresponding simctl subcommand command

package/build/lib/subcommands/list.d.ts

@@ -29,22 +29,22 @@ declare namespace commands {
      * Parse the list of existing Simulator devices to represent
      * it as convenient mapping.
      *
-     * @param {string?} platform - The platform name, for example 'watchOS'.
+     * @param {string?} [platform] - The platform name, for example 'watchOS'.
      * @return {Promise<Record<string, any>>} The resulting mapping. Each key is platform version,
      *                  for example '10.3' and the corresponding value is an
      *                  array of the matching {@link DeviceInfo} instances.
      * @throws {Error} If the corresponding simctl subcommand command
      *                 returns non-zero return code.
      */
-    function getDevicesByParsing(platform: string | null): Promise<Record<string, any>>;
+    function getDevicesByParsing(platform?: string | null | undefined): Promise<Record<string, any>>;
     /**
      * Parse the list of existing Simulator devices to represent
      * it as convenient mapping for the particular platform version.
      *
-     * @param {string?} forSdk - The sdk version,
+     * @param {string?} [forSdk] - The sdk version,
      *                           for which the devices list should be parsed,
      *                           for example '10.3'.
-     * @param {string?} platform - The platform name, for example 'watchOS'.
+     * @param {string?} [platform] - The platform name, for example 'watchOS'.
      * @return {Promise<Object|DeviceInfo[]>} If _forSdk_ is set then the list
      *                                    of devices for the particular platform version.
      *                                    Otherwise the same result as for {@link getDevicesByParsing}
@@ -53,27 +53,27 @@ declare namespace commands {
      *                 returns non-zero return code or if no matching
      *                 platform version is found in the system.
      */
-    function getDevices(forSdk: string | null, platform: string | null): Promise<any>;
+    function getDevices(forSdk?: string | null | undefined, platform?: string | null | undefined): Promise<any>;
     /**
      * Get the runtime for the particular platform version using --json flag
      *
      * @param {string} platformVersion - The platform version name,
      *                                   for example '10.3'.
-     * @param {string} platform - The platform name, for example 'watchOS'.
+     * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
      * @return {Promise<string>} The corresponding runtime name for the given
      *                  platform version.
      */
-    function getRuntimeForPlatformVersionViaJson(platformVersion: string, platform?: string): Promise<string>;
+    function getRuntimeForPlatformVersionViaJson(platformVersion: string, platform?: string | undefined): Promise<string>;
     /**
      * Get the runtime for the particular platform version.
      *
      * @param {string} platformVersion - The platform version name,
      *                                   for example '10.3'.
-     * @param {string} platform - The platform name, for example 'watchOS'.
+     * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
      * @return {Promise<string>} The corresponding runtime name for the given
      *                  platform version.
      */
-    function getRuntimeForPlatformVersion(platformVersion: string, platform?: string): Promise<string>;
+    function getRuntimeForPlatformVersion(platformVersion: string, platform?: string | undefined): Promise<string>;
     /**
      * Get the list of device types available in the current Xcode installation
      *

package/build/lib/subcommands/list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/list.js"],"names":[],"mappings":";;;;;UASc,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;SACN,MAAM;;;IALpB;;;;;;OAMG;IAEH;;;;;;;;;;OAUG;IACH,oFA4DC;IAED;;;;;;;;;;;;;;;OAeG;IACH,kFAmEC;IAED;;;;;;;;OAQG;IACH,0GAYC;IAED;;;;;;;;OAQG;IACH,mGAoBC;IAED;;;;;OAKG;IACH,6CAqBC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,8BASC"}
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/list.js"],"names":[],"mappings":";;;;;UASc,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;SACN,MAAM;;;IALpB;;;;;;OAMG;IAEH;;;;;;;;;;OAUG;IACH,iGA4DC;IAED;;;;;;;;;;;;;;;OAeG;IACH,4GAmEC;IAED;;;;;;;;OAQG;IACH,sHAYC;IAED;;;;;;;;OAQG;IACH,+GAoBC;IAED;;;;;OAKG;IACH,6CAqBC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,8BASC"}

package/build/lib/subcommands/list.js

@@ -41,7 +41,7 @@ const commands = {};
  * Parse the list of existing Simulator devices to represent
  * it as convenient mapping.
  *
- * @param {string?} platform - The platform name, for example 'watchOS'.
+ * @param {string?} [platform] - The platform name, for example 'watchOS'.
  * @return {Promise<Record<string, any>>} The resulting mapping. Each key is platform version,
  *                  for example '10.3' and the corresponding value is an
  *                  array of the matching {@link DeviceInfo} instances.
@@ -111,10 +111,10 @@ commands.getDevicesByParsing = async function getDevicesByParsing(platform) {
  * Parse the list of existing Simulator devices to represent
  * it as convenient mapping for the particular platform version.
  *
- * @param {string?} forSdk - The sdk version,
+ * @param {string?} [forSdk] - The sdk version,
  *                           for which the devices list should be parsed,
  *                           for example '10.3'.
- * @param {string?} platform - The platform name, for example 'watchOS'.
+ * @param {string?} [platform] - The platform name, for example 'watchOS'.
  * @return {Promise<Object|DeviceInfo[]>} If _forSdk_ is set then the list
  *                                    of devices for the particular platform version.
  *                                    Otherwise the same result as for {@link getDevicesByParsing}
@@ -193,7 +193,7 @@ commands.getDevices = async function getDevices(forSdk, platform) {
  *
  * @param {string} platformVersion - The platform version name,
  *                                   for example '10.3'.
- * @param {string} platform - The platform name, for example 'watchOS'.
+ * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
  * @return {Promise<string>} The corresponding runtime name for the given
  *                  platform version.
  */
@@ -214,7 +214,7 @@ commands.getRuntimeForPlatformVersionViaJson = async function getRuntimeForPlatf
  *
  * @param {string} platformVersion - The platform version name,
  *                                   for example '10.3'.
- * @param {string} platform - The platform name, for example 'watchOS'.
+ * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
  * @return {Promise<string>} The corresponding runtime name for the given
  *                  platform version.
  */

package/build/lib/subcommands/pbcopy.d.ts

@@ -6,12 +6,12 @@ declare namespace commands {
      *
      * @since Xcode SDK 8.1
      * @param {string} content - The actual string content to be set.
-     * @param {string} encoding [utf8] - The encoding of the given pasteboard content.
+     * @param {string} [encoding='utf8'] - The encoding of the given pasteboard content.
      *                                   UTF-8 by default.
      * @throws {Error} If the corresponding simctl subcommand command
      *                 returns non-zero return code.
      * @throws {Error} If the `udid` instance property is unset
      */
-    function setPasteboard(content: string, encoding?: string): Promise<void>;
+    function setPasteboard(content: string, encoding?: string | undefined): Promise<void>;
 }
 //# sourceMappingURL=pbcopy.d.ts.map

package/build/lib/subcommands/pbcopy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pbcopy.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/pbcopy.js"],"names":[],"mappings":";;IAEA;;;;;;;;;;;OAWG;IACH,0EAYC"}
+{"version":3,"file":"pbcopy.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/pbcopy.js"],"names":[],"mappings":";;IAEA;;;;;;;;;;;OAWG;IACH,sFAYC"}

package/build/lib/subcommands/pbcopy.js

@@ -7,7 +7,7 @@ const commands = {};
  *
  * @since Xcode SDK 8.1
  * @param {string} content - The actual string content to be set.
- * @param {string} encoding [utf8] - The encoding of the given pasteboard content.
+ * @param {string} [encoding='utf8'] - The encoding of the given pasteboard content.
  *                                   UTF-8 by default.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.

package/build/lib/subcommands/pbpaste.d.ts

@@ -5,13 +5,13 @@ declare namespace commands {
      * It is required that Simulator is in _booted_ state.
      *
      * @since Xcode 8.1 SDK
-     * @param {string} encoding ['utf-8'] - The encoding of the returned pasteboard content.
+     * @param {string} [encoding='utf8'] - The encoding of the returned pasteboard content.
      *                                      UTF-8 by default.
      * @return {Promise<string>} Current content of Simulator pasteboard or an empty string.
      * @throws {Error} If the corresponding simctl subcommand command
      *                 returns non-zero return code.
      * @throws {Error} If the `udid` instance property is unset
      */
-    function getPasteboard(encoding?: string): Promise<string>;
+    function getPasteboard(encoding?: string | undefined): Promise<string>;
 }
 //# sourceMappingURL=pbpaste.d.ts.map

package/build/lib/subcommands/pbpaste.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pbpaste.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/pbpaste.js"],"names":[],"mappings":";;IAEA;;;;;;;;;;;OAWG;IACH,2DAMC"}
+{"version":3,"file":"pbpaste.d.ts","sourceRoot":"","sources":["../../../lib/subcommands/pbpaste.js"],"names":[],"mappings":";;IAEA;;;;;;;;;;;OAWG;IACH,uEAMC"}

package/build/lib/subcommands/pbpaste.js

@@ -6,7 +6,7 @@ const commands = {};
  * It is required that Simulator is in _booted_ state.
  *
  * @since Xcode 8.1 SDK
- * @param {string} encoding ['utf-8'] - The encoding of the returned pasteboard content.
+ * @param {string} [encoding='utf8'] - The encoding of the returned pasteboard content.
  *                                      UTF-8 by default.
  * @return {Promise<string>} Current content of Simulator pasteboard or an empty string.
  * @throws {Error} If the corresponding simctl subcommand command

package/build/lib/subcommands/spawn.d.ts

@@ -5,7 +5,7 @@ declare namespace commands {
      * It is required that Simulator is in _booted_ state.
      *
      * @param {string|string[]} args - Spawn arguments
-     * @param {object} env [{}] - Additional environment variables mapping.
+     * @param {object} [env={}] - Additional environment variables mapping.
      * @return {Promise<import('teen_process').TeenProcessExecResult>} Command execution result.
      * @throws {Error} If the corresponding simctl subcommand command
      *                 returns non-zero return code.
@@ -17,7 +17,7 @@ declare namespace commands {
      * on Simulator.
      *
      * @param {string|string[]} args - Spawn arguments
-     * @param {object} env [{}] - Additional environment variables mapping.
+     * @param {object} [env={}] - Additional environment variables mapping.
      * @return {Promise<import('teen_process').SubProcess>} The instance of the process to be spawned.
      * @throws {Error} If the `udid` instance property is unset
      */

package/build/lib/subcommands/spawn.js

@@ -10,7 +10,7 @@ const commands = {};
  * It is required that Simulator is in _booted_ state.
  *
  * @param {string|string[]} args - Spawn arguments
- * @param {object} env [{}] - Additional environment variables mapping.
+ * @param {object} [env={}] - Additional environment variables mapping.
  * @return {Promise<import('teen_process').TeenProcessExecResult>} Command execution result.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.
@@ -30,7 +30,7 @@ commands.spawnProcess = async function spawnProcess(args, env = {}) {
  * on Simulator.
  *
  * @param {string|string[]} args - Spawn arguments
- * @param {object} env [{}] - Additional environment variables mapping.
+ * @param {object} [env={}] - Additional environment variables mapping.
  * @return {Promise<import('teen_process').SubProcess>} The instance of the process to be spawned.
  * @throws {Error} If the `udid` instance property is unset
  */

package/lib/helpers.js

@@ -1,7 +1,7 @@
 import semver from 'semver';
 
-const DEFAULT_EXEC_TIMEOUT = 10 * 60 * 1000; // ms
-const SIM_RUNTIME_NAME = 'com.apple.CoreSimulator.SimRuntime.';
+export const DEFAULT_EXEC_TIMEOUT = 10 * 60 * 1000; // ms
+export const SIM_RUNTIME_NAME = 'com.apple.CoreSimulator.SimRuntime.';
 
 /**
  * "Normalize" the version, since iOS uses 'major.minor' but the runtimes can
@@ -11,7 +11,7 @@ const SIM_RUNTIME_NAME = 'com.apple.CoreSimulator.SimRuntime.';
  * @return {string} The version in 'major.minor' form
  * @throws {Error} If the version not parseable by the `semver` package
  */
-function normalizeVersion (version) {
+export function normalizeVersion (version) {
   const semverVersion = semver.coerce(version);
   if (!semverVersion) {
     throw new Error(`Unable to parse version '${version}'`);
@@ -19,9 +19,9 @@ function normalizeVersion (version) {
   return `${semverVersion.major}.${semverVersion.minor}`;
 }
 
-export {
-  DEFAULT_EXEC_TIMEOUT, SIM_RUNTIME_NAME,
-  normalizeVersion,
-};
-
-export const getXcrunBinary = () => process.env.XCRUN_BINARY || 'xcrun';
+/**
+ * @returns {string}
+ */
+export function getXcrunBinary () {
+  return process.env.XCRUN_BINARY || 'xcrun';
+}

package/lib/simctl.js

@@ -16,45 +16,50 @@ const DEFAULT_OPTS = {
   logErrors: true,
 };
 
+/**
+ * @typedef {Object} XCRun
+ * @property {string?} path Full path to the xcrun script
+ */
+
 /**
  * @typedef {Object} ExecOpts
- * @property {string[]} args [[]] - The list of additional subcommand arguments.
+ * @property {string[]} [args=[]] - The list of additional subcommand arguments.
  * It's empty by default.
- * @property {Object} env [{}] - Environment variables mapping. All these variables
+ * @property {Record<string, any>} [env={}] - Environment variables mapping. All these variables
  * will be passed Simulator and used in the executing function.
- * @property {boolean} logErrors [true] - Set it to _false_ to throw execution errors
+ * @property {boolean} [logErrors=true] - Set it to _false_ to throw execution errors
  * immediately without logging any additional information.
- * @property {boolean} asynchronous [false] - Whether to execute the given command
+ * @property {boolean} [asynchronous=false] - Whether to execute the given command
  * 'synchronously' or 'asynchronously'. Affects the returned result of the function.
- * @property {string?} encoding - Explicitly sets streams encoding for the executed
+ * @property {string} [encoding] - Explicitly sets streams encoding for the executed
  * command input and outputs.
- * @property {string|string[]} architectures - One or more architecture names to be enforced while
+ * @property {string|string[]} [architectures] - One or more architecture names to be enforced while
  * executing xcrun. See https://github.com/appium/appium/issues/18966 for more details.
  */
 
 
 /**
  * @typedef {Object} SimctlOpts
- * @property {Object?} xcrun - The xcrun properties. Currently only one property
+ * @property {XCRun} [xcrun] - The xcrun properties. Currently only one property
  * is supported, which is `path` and it by default contains `null`, which enforces
  * the instance to automatically detect the full path to `xcrun` tool and to throw
  * an exception if it cannot be detected. If the path is set upon instance creation
  * 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 maximum number of milliseconds
  * to wait for single synchronous xcrun command.
- * @property {boolean} logErrors [true] - Whether to wire xcrun error messages
+ * @property {boolean} [logErrors=true] - Whether to wire xcrun error messages
  * into debug log before throwing them.
- * @property {string?} udid - The unique identifier of the current device, which is
+ * @property {string?} [udid] - The unique identifier of the current device, which is
  * going to be implicitly passed to all methods, which require it. It can either be set
  * upon instance creation if it is already known in advance or later when/if needed via the
  * corresponding instance setter.
- * @property {string?} devicesSetPath - Full path to the set of devices that you want to manage.
+ * @property {string?} [devicesSetPath] - Full path to the set of devices that you want to manage.
  * By default this path usually equals to ~/Library/Developer/CoreSimulator/Devices
  */
 
 
 class Simctl {
-  /** @type {any?} */
+  /** @type {XCRun} */
   xcrun;
 
   /** @type {number} */
@@ -64,7 +69,7 @@ class Simctl {
   logErrors;
 
   /**
-   * @param {Partial<SimctlOpts>} opts
+   * @param {SimctlOpts} [opts={}]
    */
   constructor (opts = {}) {
     opts = _.cloneDeep(opts);
@@ -72,7 +77,9 @@ class Simctl {
     for (const key of _.keys(DEFAULT_OPTS)) {
       this[key] = opts[key];
     }
+    /** @type {string?} */
     this._udid = _.isNil(opts.udid) ? null : opts.udid;
+    /** @type {string?} */
     this._devicesSetPath = _.isNil(opts.devicesSetPath) ? null : opts.devicesSetPath;
   }
 
@@ -118,10 +125,10 @@ class Simctl {
    * Execute the particular simctl command.
    *
    * @param {string} subcommand - One of available simctl subcommands.
-   *                           Execute `xcrun simctl` in Terminal to see the full list
-   *                           of available subcommands.
-   * @param {Partial<ExecOpts>} opts
-   * @return {Promise<import('teen_process').TeenProcessExecResult|import('teen_process').SubProcess>} Either the result of teen process's `exec` or
+   * Execute `xcrun simctl` in Terminal to see the full list  of available subcommands.
+   * @param {ExecOpts} [opts={}]
+   * @return {Promise<import('teen_process').TeenProcessExecResult|import('teen_process').SubProcess>}
+   * Either the result of teen process's `exec` or
    * `SubProcess` instance depending of `opts.asynchronous` value.
    * @throws {Error} If the simctl subcommand command returns non-zero return code.
    */
@@ -135,7 +142,8 @@ class Simctl {
       architectures,
     } = opts;
     // run a particular simctl command
-    args = ['simctl',
+    args = [
+      'simctl',
       ...(this.devicesSetPath ? ['--set', this.devicesSetPath] : []),
       subcommand,
       ...args
@@ -145,7 +153,8 @@ class Simctl {
     env = _.defaults(
       _.mapKeys(env,
         (value, key) => _.startsWith(key, SIMCTL_ENV_PREFIX) ? key : `${SIMCTL_ENV_PREFIX}${key}`),
-      process.env);
+      process.env
+    );
 
     const execOpts = {
       env,
@@ -157,7 +166,7 @@ class Simctl {
     const xcrun = await this.requireXcrun();
     try {
       let execArgs = [xcrun, args, execOpts];
-      if (!_.isEmpty(architectures)) {
+      if (architectures?.length) {
         const archArgs = _.flatMap(
           (_.isArray(architectures) ? architectures : [architectures]).map((arch) => ['-arch', arch])
         );

package/lib/subcommands/bootstatus.js

@@ -6,13 +6,13 @@ const commands = {};
 
 /**
  * @typedef {Object} BootMonitorOptions
- * @property {number} timeout [240000] - Simulator booting timeout in ms.
- * @property {Function?} onWaitingDataMigration - This event is fired when data migration stage starts.
- * @property {Function?} onWaitingSystemApp - This event is fired when system app wait stage starts.
- * @property {Function?} onFinished - This event is fired when Simulator is fully booted.
- * @property {Function?} onError - This event is fired when there was an error while monitoring the booting process
+ * @property {number} [timeout=240000] - Simulator booting timeout in ms.
+ * @property {Function} [onWaitingDataMigration] - This event is fired when data migration stage starts.
+ * @property {Function} [onWaitingSystemApp] - This event is fired when system app wait stage starts.
+ * @property {Function} [onFinished] - This event is fired when Simulator is fully booted.
+ * @property {Function} [onError] - This event is fired when there was an error while monitoring the booting process
  * or when the timeout has expired.
- * @property {boolean} shouldPreboot [false] Whether to preboot the Simulator
+ * @property {boolean} [shouldPreboot=false] Whether to preboot the Simulator
  * if this command is called and it is not already in booted or booting state.
  */
 
@@ -22,7 +22,7 @@ const commands = {};
  * until Simulator booting is completed.
  * The method is only available since Xcode8.
  *
- * @param {Partial<BootMonitorOptions>} opts - Monitoring options.
+ * @param {BootMonitorOptions} [opts={}] - Monitoring options.
  * @returns {Promise<import('teen_process').SubProcess>} The instance of the corresponding monitoring process.
  * @throws {Error} If the Simulator fails to finish booting within the given timeout and onFinished
  * property is not set.

package/lib/subcommands/create.js

@@ -11,8 +11,8 @@ const commands = {};
 
 /**
  * @typedef {Object} SimCreationOpts
- * @property {string} platform [iOS] - Platform name in order to specify runtime such as 'iOS', 'tvOS', 'watchOS'
- * @property {number} timeout [10000] - The maximum number of milliseconds to wait
+ * @property {string} [platform='iOS'] - Platform name in order to specify runtime such as 'iOS', 'tvOS', 'watchOS'
+ * @property {number} [timeout=10000] - The maximum number of milliseconds to wait
  *                                      unit device creation is completed.
  */
 
@@ -23,7 +23,7 @@ const commands = {};
  * @param {string} name - The device name to be created.
  * @param {string} deviceTypeId - Device type, for example 'iPhone 6'.
  * @param {string} platformVersion - Platform version, for example '10.3'.
- * @param {Partial<SimCreationOpts>} opts - Simulator options for creating devices.
+ * @param {SimCreationOpts} [opts={}] - Simulator options for creating devices.
  * @return {Promise<string>} The UDID of the newly created device.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.

package/lib/subcommands/erase.js

@@ -6,7 +6,7 @@ const commands = {};
  * Reset the content and settings of the particular Simulator.
  * It is required that Simulator is in _shutdown_ state.
  *
- * @param {number} timeout [10000] - The maximum number of milliseconds to wait
+ * @param {number} [timeout=10000] - The maximum number of milliseconds to wait
  *                                   unit device reset is completed.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.

package/lib/subcommands/get_app_container.js

@@ -8,7 +8,7 @@ const commands = {};
  * It is required that Simulator is in _booted_ state.
  *
  * @param {string} bundleId - Bundle identifier of an application.
- * @param {string?} containerType - Which container type to return. Possible values
+ * @param {string?} [containerType=null] - Which container type to return. Possible values
  *                                  are 'app', 'data', 'groups', '<A specific App Group container>'.
  *                                  The default value is 'app'.
  * @return {Promise<string>} Full path to the given application container on the local

package/lib/subcommands/keychain.js

@@ -24,7 +24,7 @@ async function handleRawPayload (payload, onPayloadStored) {
 
 /**
  * @typedef {Object} CertOptions
- * @property {boolean} raw [false] - whether the `cert` argument
+ * @property {boolean} [raw=false] - whether the `cert` argument
  * is the path to the certificate on the local file system or
  * a raw certificate content
  */
@@ -36,7 +36,7 @@ async function handleRawPayload (payload, onPayloadStored) {
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
- * @param {Partial<CertOptions>} opts
+ * @param {CertOptions} [opts={}]
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while adding the certificate
  * @throws {Error} If the `udid` instance property is unset
@@ -62,7 +62,7 @@ commands.addRootCertificate = async function addRootCertificate (cert, opts = {}
  * @param {string} cert the full path to a valid .cert file containing
  * the certificate content or the certificate content itself, depending on
  * options
- * @param {Partial<CertOptions>} opts
+ * @param {CertOptions} [opts={}]
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while adding the certificate
  * @throws {Error} If the `udid` instance property is unset

package/lib/subcommands/launch.js

@@ -10,7 +10,7 @@ const commands = {};
  *
  * @param {string} bundleId - Bundle identifier of the application,
  *                            which is going to be removed.
- * @param {number} tries [5] - The maximum number of retries before
+ * @param {number} [tries=5] - The maximum number of retries before
  *                             throwing an exception.
  * @return {Promise<string>} the actual command output
  * @throws {Error} If the corresponding simctl subcommand command

package/lib/subcommands/list.js

@@ -17,7 +17,7 @@ const commands = {};
  * Parse the list of existing Simulator devices to represent
  * it as convenient mapping.
  *
- * @param {string?} platform - The platform name, for example 'watchOS'.
+ * @param {string?} [platform] - The platform name, for example 'watchOS'.
  * @return {Promise<Record<string, any>>} The resulting mapping. Each key is platform version,
  *                  for example '10.3' and the corresponding value is an
  *                  array of the matching {@link DeviceInfo} instances.
@@ -90,10 +90,10 @@ commands.getDevicesByParsing = async function getDevicesByParsing (platform) {
  * Parse the list of existing Simulator devices to represent
  * it as convenient mapping for the particular platform version.
  *
- * @param {string?} forSdk - The sdk version,
+ * @param {string?} [forSdk] - The sdk version,
  *                           for which the devices list should be parsed,
  *                           for example '10.3'.
- * @param {string?} platform - The platform name, for example 'watchOS'.
+ * @param {string?} [platform] - The platform name, for example 'watchOS'.
  * @return {Promise<Object|DeviceInfo[]>} If _forSdk_ is set then the list
  *                                    of devices for the particular platform version.
  *                                    Otherwise the same result as for {@link getDevicesByParsing}
@@ -176,7 +176,7 @@ commands.getDevices = async function getDevices (forSdk, platform) {
  *
  * @param {string} platformVersion - The platform version name,
  *                                   for example '10.3'.
- * @param {string} platform - The platform name, for example 'watchOS'.
+ * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
  * @return {Promise<string>} The corresponding runtime name for the given
  *                  platform version.
  */
@@ -199,7 +199,7 @@ commands.getRuntimeForPlatformVersionViaJson = async function getRuntimeForPlatf
  *
  * @param {string} platformVersion - The platform version name,
  *                                   for example '10.3'.
- * @param {string} platform - The platform name, for example 'watchOS'.
+ * @param {string} [platform='iOS'] - The platform name, for example 'watchOS'.
  * @return {Promise<string>} The corresponding runtime name for the given
  *                  platform version.
  */