1. module cross-spawn
   1. function cross-spawn (command, args, options)
   2. function cross-spawn._parse (command, args, options)
   3. function cross-spawn.spawn (command, args, options)
   4. function cross-spawn.sync (command, args, options)
   5. object cross-spawn._enoent
2. module cross-spawn._enoent
   1. function cross-spawn._enoent.hookChildProcess (cp, parsed)
   2. function cross-spawn._enoent.notFoundError (command, syscall)
   3. function cross-spawn._enoent.verifyENOENT (status, parsed)
   4. function cross-spawn._enoent.verifyENOENTSync (status, parsed)
3. module cross-spawn.spawn
   1. function cross-spawn.spawn (command, args, options)
   2. function cross-spawn.spawn._parse (command, args, options)
   3. function cross-spawn.spawn.sync (command, args, options)
   4. object cross-spawn.spawn._enoent

module cross-spawn

function cross-spawn (command, args, options)

• description and source-code

  function spawn(command, args, options) {
      var parsed;
      var spawned;
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
  
      // Hook into child process "exit" event to emit an error if the command
      // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      enoent.hookChildProcess(spawned, parsed);
  
      return spawned;
  }

• example usage

  n/a

function cross-spawn._parse (command, args, options)

• description and source-code

  function parse(command, args, options) {
      var parsed;
  
      // Normalize arguments, similar to nodejs
      if (args && !Array.isArray(args)) {
          options = args;
          args = null;
      }
  
      args = args ? args.slice(0) : [];  // Clone array to avoid changing the original
      options = options || {};
  
      // Build our parsed object
      parsed = {
          command: command,
          args: args,
          options: options,
          file: undefined,
          original: command,
      };
  
      // Delegate further parsing to shell or non-shell
      return options.shell ? parseShell(parsed) : parseNonShell(parsed);
  }

• example usage

  n/a

function cross-spawn.spawn (command, args, options)

• description and source-code

  function spawn(command, args, options) {
      var parsed;
      var spawned;
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
  
      // Hook into child process "exit" event to emit an error if the command
      // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      enoent.hookChildProcess(spawned, parsed);
  
      return spawned;
  }

• example usage

  ...
      var parsed;
      var spawned;
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
  
      // Hook into child process "exit" event to emit an error if the command
      // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      enoent.hookChildProcess(spawned, parsed);
  
      return spawned;
  }
  ...

function cross-spawn.sync (command, args, options)

• description and source-code

  function spawnSync(command, args, options) {
      var parsed;
      var result;
  
      if (!cpSpawnSync) {
          try {
              cpSpawnSync = require('spawn-sync');  // eslint-disable-line global-require
          } catch (ex) {
              throw new Error(
                  'In order to use spawnSync on node 0.10 or older, you must ' +
                  'install spawn-sync:\n\n' +
                  '  npm install spawn-sync --save'
              );
          }
      }
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      result = cpSpawnSync(parsed.command, parsed.args, parsed.options);
  
      // Analyze if the command does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      result.error = result.error || enoent.verifyENOENTSync(result.status, parsed);
  
      return result;
  }

• example usage

  ...
  ```js
  var spawn = require('cross-spawn');
  
  // Spawn NPM asynchronously
  var child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit
  ' });
  
  // Spawn NPM synchronously
  var results = spawn.sync('npm', ['list', '-g', '-depth
  ', '0'], { stdio: 'inherit' });
  ```
  
  
  ## Caveats
  
  #### `options.shell` as an alternative to `cross-spawn`
  ...

module cross-spawn._enoent

function cross-spawn._enoent.hookChildProcess (cp, parsed)

• description and source-code

  function hookChildProcess(cp, parsed) {
      var originalEmit;
  
      if (!isWin) {
          return;
      }
  
      originalEmit = cp.emit;
      cp.emit = function (name, arg1) {
          var err;
  
          // If emitting "exit" event and exit code is 1, we need to check if
          // the command exists and emit an "error" instead
          // See: https://github.com/IndigoUnited/node-cross-spawn/issues/16
          if (name === 'exit') {
              err = verifyENOENT(arg1, parsed, 'spawn');
  
              if (err) {
                  return originalEmit.call(cp, 'error', err);
              }
          }
  
          return originalEmit.apply(cp, arguments);
      };
  }

• example usage

  ...
  parsed = parse(command, args, options);
  
  // Spawn the child process
  spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
  
  // Hook into child process "exit" event to emit an error if the command
  // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
  enoent.hookChildProcess(spawned, parsed);
  
  return spawned;
  }
  
  function spawnSync(command, args, options) {
  var parsed;
  var result;
  ...

function cross-spawn._enoent.notFoundError (command, syscall)

• description and source-code

  function notFoundError(command, syscall) {
      var err;
  
      err = new Error(syscall + ' ' + command + ' ENOENT');
      err.code = err.errno = 'ENOENT';
      err.syscall = syscall + ' ' + command;
  
      return err;
  }

• example usage

  n/a

function cross-spawn._enoent.verifyENOENT (status, parsed)

• description and source-code

  function verifyENOENT(status, parsed) {
      if (isWin && status === 1 && !parsed.file) {
          return notFoundError(parsed.original, 'spawn');
      }
  
      return null;
  }

• example usage

  n/a

function cross-spawn._enoent.verifyENOENTSync (status, parsed)

• description and source-code

  function verifyENOENTSync(status, parsed) {
      if (isWin && status === 1 && !parsed.file) {
          return notFoundError(parsed.original, 'spawnSync');
      }
  
      // If we are in node 10, then we are using spawn-sync; if it exited
      // with -1 it probably means that the command does not exist
      if (isNode10 && status === -1) {
          parsed.file = isWin ? parsed.file : resolveCommand(parsed.original);
  
          if (!parsed.file) {
              return notFoundError(parsed.original, 'spawnSync');
          }
      }
  
      return null;
  }

• example usage

  ...
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      result = cpSpawnSync(parsed.command, parsed.args, parsed.options);
  
      // Analyze if the command does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      result.error = result.error || enoent.verifyENOENTSync(result.status, parsed);
  
      return result;
  }
  
  module.exports = spawn;
  module.exports.spawn = spawn;
  module.exports.sync = spawnSync;
  ...

module cross-spawn.spawn

function cross-spawn.spawn (command, args, options)

• description and source-code

  function spawn(command, args, options) {
      var parsed;
      var spawned;
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
  
      // Hook into child process "exit" event to emit an error if the command
      // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      enoent.hookChildProcess(spawned, parsed);
  
      return spawned;
  }

• example usage

  ...
      var parsed;
      var spawned;
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      spawned = cp.spawn(parsed.command, parsed.args, parsed.options);
  
      // Hook into child process "exit" event to emit an error if the command
      // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      enoent.hookChildProcess(spawned, parsed);
  
      return spawned;
  }
  ...

function cross-spawn.spawn._parse (command, args, options)

• description and source-code

  function parse(command, args, options) {
      var parsed;
  
      // Normalize arguments, similar to nodejs
      if (args && !Array.isArray(args)) {
          options = args;
          args = null;
      }
  
      args = args ? args.slice(0) : [];  // Clone array to avoid changing the original
      options = options || {};
  
      // Build our parsed object
      parsed = {
          command: command,
          args: args,
          options: options,
          file: undefined,
          original: command,
      };
  
      // Delegate further parsing to shell or non-shell
      return options.shell ? parseShell(parsed) : parseNonShell(parsed);
  }

• example usage

  n/a

function cross-spawn.spawn.sync (command, args, options)

• description and source-code

  function spawnSync(command, args, options) {
      var parsed;
      var result;
  
      if (!cpSpawnSync) {
          try {
              cpSpawnSync = require('spawn-sync');  // eslint-disable-line global-require
          } catch (ex) {
              throw new Error(
                  'In order to use spawnSync on node 0.10 or older, you must ' +
                  'install spawn-sync:\n\n' +
                  '  npm install spawn-sync --save'
              );
          }
      }
  
      // Parse the arguments
      parsed = parse(command, args, options);
  
      // Spawn the child process
      result = cpSpawnSync(parsed.command, parsed.args, parsed.options);
  
      // Analyze if the command does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16
      result.error = result.error || enoent.verifyENOENTSync(result.status, parsed);
  
      return result;
  }

• example usage

  ...
  ```js
  var spawn = require('cross-spawn');
  
  // Spawn NPM asynchronously
  var child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit
  ' });
  
  // Spawn NPM synchronously
  var results = spawn.sync('npm', ['list', '-g', '-depth
  ', '0'], { stdio: 'inherit' });
  ```
  
  
  ## Caveats
  
  #### `options.shell` as an alternative to `cross-spawn`
  ...