JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 39197
  • Score
    100M100P100Q144699F
  • License KINDLY

Limit the shell execution commands to <x> calls same time.

Package Exports

  • exec-limiter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (exec-limiter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

exec-limiter Donate now

Limit the shell execution commands to calls same time.

Installation

$ npm i exec-limiter

Example

// Dependencies
var ExecLimiter = require("exec-limiter");

// Constants
const COMMAND = "sleep 5; date;";

// Create an instance of exec limiter
var el = new ExecLimiter(2);

// #1
el.add("sleep 5", function (err) {
    console.log(err || "Waited 5 seconds for the first time.");
});

// #2
el.add("sleep", ["7"], function (err) {
    console.log(err || "Waited another 7 seconds but probably I was ran in parallel with the other process.");
});

// #3
el.add("sleep 5", function (err) {
    console.log(err || "I was ran in parallel with the second process and finished fine.");
});

// #4
el.add("ls", ["-l"], { ignoreStdout: false }, function (err, stdout) {
    console.log(err || "The spawned 'ls -l' returned:\n" + stdout);
});

// These will be executed like below:
//
// Timeline: 0-1-2-3-4-5-6-7-8-9-10-11
//
//       #1: ==========
//       #2: ==============
//       #3:            ============
//       #4:               ==
//
// Notice how they run in parallel, but not more than 2 in the same time.

Documentation

ExecLimiter(limit)

Creates a new instance of ExecLimiter.

Params

  • Number limit: The limit of commands to run same time.

Return

  • ExecLimiter The ExecLimiter instance.

add(command, args, options, callback)

Adds a new command to run in the buffer.

Usage:

el.add(command, fn); // exec
el.add(command, args, fn); // spawn
el.add(command, options, fn); // exec
el.add(command, args, options, fn); // spawn

Params

  • String command: The command to run as string.
  • Object args: The command arguments as array of strings (optional).
  • Object options: The options passed to the spawn/exec function, but extended with the following fields:
  • ignoreStdout (Boolean): If false, then the stdout output will be stored ant called back.
  • Function callback: The callback function.

Return

  • ExecLimiter The ExecLimiter instance.

How to contribute

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

Who uses this

If you are using this library in one of your projects, add it in this list. ✨

License

KINDLY © Ionică Bizău–The LICENSE file contains a copy of the license.