node-simctl 7.1.17 → 7.2.0

package/lib/subcommands/list.js

@@ -90,11 +90,11 @@ 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'.
- * @return {Object|Array<DeviceInfo>} If _forSdk_ is set then the list
+ * @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}
  *                                    function.
@@ -176,8 +176,8 @@ 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'.
- * @return {string} The corresponding runtime name for the given
+ * @param {string?} platform - The platform name, for example 'watchOS'.
+ * @return {Promise<string>} The corresponding runtime name for the given
  *                  platform version.
  */
 commands.getRuntimeForPlatformVersionViaJson = async function getRuntimeForPlatformVersionViaJson (
@@ -199,8 +199,8 @@ 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'.
- * @return {string} The corresponding runtime name for the given
+ * @param {string?} platform - The platform name, for example 'watchOS'.
+ * @return {Promise<string>} The corresponding runtime name for the given
  *                  platform version.
  */
 commands.getRuntimeForPlatformVersion = async function getRuntimeForPlatformVersion (
@@ -228,7 +228,7 @@ commands.getRuntimeForPlatformVersion = async function getRuntimeForPlatformVers
 /**
  * Get the list of device types available in the current Xcode installation
  *
- * @return {Array<string>} List of the types of devices available
+ * @return {Promise<string[]>} List of the types of devices available
  * @throws {Error} If the corresponding simctl command fails
  */
 commands.getDeviceTypes = async function getDeviceTypes () {
@@ -257,7 +257,7 @@ commands.getDeviceTypes = async function getDeviceTypes () {
 /**
  * Get the full list of runtimes, devicetypes, devices and pairs as Object
  *
- * @return {Object} Object containing device types, runtimes devices and pairs.
+ * @return {Promise<Object>} Object containing device types, runtimes devices and pairs.
  * The resulting JSON will be like:
  *   {
  *     "devicetypes" : [

package/lib/subcommands/openurl.js

@@ -7,7 +7,7 @@ const commands = {};
  *
  * @param {string} url - The URL scheme to open, for example http://appiom.io
  *                       will be opened by the built-in mobile browser.
- * @return {ExecResult} Command execution result.
+ * @return {Promise<ExecResult>} Command execution result.
  * @throws {Error} If the corresponding simctl subcommand command
  *                 returns non-zero return code.
  * @throws {Error} If the `udid` instance property is unset

package/lib/subcommands/pbcopy.js

@@ -6,7 +6,7 @@ const commands = {};
  *
  * @since Xcode SDK 8.1
  * @param {string} content - The actual string content to be set.
- * @param {string} encoding [utf'] - 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/lib/subcommands/pbpaste.js

@@ -7,7 +7,7 @@ const commands = {};
  * @since Xcode 8.1 SDK
  * @param {string} encoding ['utf-8'] - The encoding of the returned pasteboard content.
  *                                      UTF-8 by default.
- * @return {string} Current content of Simulator pasteboard or an empty string.
+ * @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

package/lib/subcommands/spawn.js

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

package/lib/subcommands/ui.js

@@ -7,7 +7,7 @@ const commands = {};
  * Retrieves the current UI appearance value from the given simulator
  *
  * @since Xcode 11.4 SDK
- * @return {string} the appearance value, for example 'light' or 'dark'
+ * @return {Promise<string>} the appearance value, for example 'light' or 'dark'
  * @throws {Error} if the current SDK version does not support the command
  * or there was an error while getting the value
  * @throws {Error} If the `udid` instance property is unset

package/package.json

@@ -6,7 +6,7 @@
     "ios",
     "simctl"
   ],
-  "version": "7.1.17",
+  "version": "7.2.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {