Socket
Socket
Sign inDemoInstall

promised-exec

Package Overview
Dependencies
1
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

promised-exec

Promised execution of terminal command.


Version published
Maintainers
1
Weekly downloads
556
decreased by-24.76%

Weekly downloads

Readme

Source

promised-exec

Promised version of NodeJS child_process exec.

How to install this module?

To install this module use following command at root path of your module:

npm install promised-exec --save

Usage

This module exports function which waits only one argument on input: string with terminal command.

Function returns promise (based on library "q").

If command is invalid, the catch function will be called with object which contains string with error, and default error buffer (argument error of exec callback).

If command is valid, but response of command is error, the catch function will be called with object which contains string with error, and default error buffer (argument error of exec callback).

If command is valid, and response is correct, the the function will be called with string which contains response of command.

Example (correct command):


var exec, promise;

exec = require('promised-exec');

promise = exec('ls -l');

promise.then(function (responseString) {

    /*
     * Now variable 'responseString' contains string:
     *
     *  "-rwxrwxrwx 1 root root   29 дек  6 09:58 config.json
     *   -rwxrwxrwx 1 root root  142 дек  6 09:58 gulpfile.js
     *   -rwxrwxrwx 1 root root  224 дек  6 09:58 gulptask.test.js
     *   -rwxrwxrwx 1 root root  796 дек  6 10:34 index.js
     *   -rwxrwxrwx 1 root root 1093 дек  6 09:58 LICENSE
     *   drwxrwxrwx 1 root root    0 дек  6 09:59 node_modules
     *   -rwxrwxrwx 1 root root  713 дек  6 09:58 package.json
     *   -rwxrwxrwx 1 root root 3051 дек  6 10:51 README.md
     *   drwxrwxrwx 1 root root    0 дек  6 10:35 tests"
     *
     */

});

. . .

Example (incorrect command):


var exec, promise;

exec = require('promised-exec');

promise = exec('some-unknown-command');

promise.catch(function (errorObject) {

    /*
     * Now variable 'errorObject' contains object:
     *
     *   {"buffer": <Buffer>,"string":"Error: Command failed: /bin/sh: some-unknown-command: command not found\n"}
     *
     */

});

. . .

Example (incorrect command arguments):


var exec, promise;

exec = require('promised-exec');

promise = exec('ls -w');

promise.catch(function (errorObject) {

    /*
     * Now variable 'errorObject' contains object:
     *
     *   {"buffer": <Buffer>,"string":"Error: Command failed: ls: key must be used with argument \"w\"\nUse command \"ls --help\" to get additional information.\n"}
     *
     */

});

. . .

Keywords

FAQs

Last updated on 13 Dec 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc