spawno

Easily work with child processes.

:cloud: Installation

# Using npm
npm install --save spawno

# Using yarn
yarn add spawno

:clipboard: Example

import path from "node:path";
import { fileURLToPath } from "node:url";
import spawn from "spawno";

const __dirname = path.dirname(fileURLToPath(import.meta.url));

spawn("ls", ["-l"], { cwd: __dirname }, (err, stdout, stderr) => {
    console.log(err || stderr || stdout);
    // =>
    // total 4
    // -rw-rw-r-- 1 ionicabizau ionicabizau 256 Mar 27 14:53 index.js
});

// Pipe the output in the stdout/stderr streams (this will not collect the output in memory)
spawn("ping", ["ionicabizau.net"], {
    cwd: __dirname,
    output: true
});

// =>
// PING ionicabizau.net (109.107.37.233) 56(84) bytes of data.
// 64 bytes from cip-109-107-37-233.gb1.brightbox.com (109.107.37.233): icmp_seq=1 ttl=54 time=49.2 ms
// 64 bytes from cip-109-107-37-233.gb1.brightbox.com (109.107.37.233): icmp_seq=2 ttl=54 time=44.4 ms
// 64 bytes from cip-109-107-37-233.gb1.brightbox.com (109.107.37.233): icmp_seq=3 ttl=54 time=47.9 ms
// 64 bytes from cip-109-107-37-233.gb1.brightbox.com (109.107.37.233): icmp_seq=4 ttl=54 time=46.3 ms

// Promise interface
spawn.promise("curl", ["ionicabizau.net"]).then(console.log);

:memo: Documentation

spawno(command, args, options, cb)

Creates the child process.

Params

• string command: The command you want to run.
• Array args: The command arguments.
• object options: The options to pass to the spawn function extended with:
• output (Boolean): If truly, the output will be piped in the process stdout/stderr streams.
• data (String|Boolean): If false, the stdin stream will not be ended. By default this is an empty string.
• Function cb: The callback function.

Return

• Process The child process that was created.

spawno.promise(command, args, options)

The promise interface.

Params

• string command: The command you want to run.
• Array args: The command arguments.
• object options: The options to pass to the spawn function.

Return

• Promise The promise which will be eventually resolved with the following object:
  • code
  • stdout
  • stderr

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău