Effection Logo
@effection-contrib/tinyexecv0.1.1thefrontside/effection-contrib
JSR BadgeNPM Badge with published versionBundle size badgeDependency count badgeTree shaking support badge
import { } from "@effection-contrib/tinyexec"

tinyexec

Effection compatible wrapper around tinyexec package.

To run a process, use the x function:

import { x } from "@effection-contrib/tinyexec";
import { each, main } from "effection";

await main(function* () {
  let proc = yield* x("echo", ["Hello, World"]);

  for (let line of yield* each(proc.lines)) {
    console.log(line);
    yield* each.next();
  }
});
// => prints "Hello, World"

The process will be automatically destroyed whenever it passes out of scope. For example, the following shows the output of the top command for five seconds before exiting.

import { x } from "@effection-contrib/tinyexec";
import { each, main, sleep, spawn } from "effection";

await main(function* () {
  yield* spawn(function* () {
    let proc = yield* x("top");

    for (let line of yield* each(proc.lines)) {
      console.log(line);
      yield* each.next();
    }
  });

  yield* sleep(5000);
});

API

interface TinyProcess extends Operation<Output> {

  • A stream of lines coming from both stdin and stdout. The stream will terminate when stdout and stderr are closed which usually corresponds to the process ending.

    lines: Stream<string, void>;
  • Send signal to this process

    kill(signal?: KillSignal): Operation<void>;
}

function x(cmd: string, , options?: Partial<Options>): Operation<TinyProcess>