Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

call-bash

Package Overview
Dependencies
Maintainers
1
Versions
22
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

call-bash

Execute bash commands with non-blocking I/O.

  • 1.21.0
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

call-bash

A simple utility for using child_process.spawn inside of a Promise wrapper.

Allows for the await call(...) pattern, initially developed to play nice with the ora package, i.e.:

const ora = require('ora');
const {
    call,
    sequential
} = require('call-bash');

async function test() {
    const spinner = ora('Starting...').start();

    try {
        await call('do-task arg1 arg2');
    } catch (e) {
        return spinner.fail('Something went wrong!');
    }

    spinner.succeed('All done!');
}

Examples

const spinner = ora('Waiting...').start();
await call('sleep 1');
spinner.succeed('All done!');

Will call bash (non-blocking) and run the spinner for 1 second, then exit.

const spinner = ora('Waiting...').start();
await sequential([
    'echo "Hello"',
    'echo "World"'
]);
spinner.succeed('All done!');

Outputs:

"Hello"
"World"
✔ All done!

Source

The package simply wraps the child_process.spawn call in a Promise which is resolved on exit and rejected on error. Multiple commands may be passed in, and they will be executed in sequential order.

index.js

const callBash = async (...cmds) => {
    for (let cmd of cmds) {
        cmd = cmd.split(' ');
        await new Promise((resolve, reject) => {
            spawn(cmd.shift(), cmd, global.SPAWN_OPTIONS || DEFAULTS)
                .on('exit', resolve)
                .on('error', reject);
        });
    }
}

Footnotes

The options { stdio: 'inherit' } are passed to spawn by default, and stdout will be visible. For the sake of simplicity, the only arguments callBash takes are commands, but you can override this setting with global.SPAWN_OPTIONS if necessary.

FAQs

Package last updated on 02 Aug 2020

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc