actions-exec-listener

@actions/exec wrapper to get listener data value as return value.

Usage

1const exec = require('actions-exec-listener');
2// instead of
3// const exec = require('@actions/exec');
4
5const options = {};
6options.cwd = './lib';
7const { stdoutStr: myOutput, stderrStr: myError } = await exec.exec('node', ['index.js', 'foo=bar'], options);

Using @actions/exec

1const exec = require('@actions/exec');
2
3let myOutput = '';
4let myError = '';
5
6const options = {};
7options.listeners = {
8  stdout: (data: Buffer) => {
9    myOutput += data.toString();
10  },
11  stderr: (data: Buffer) => {
12    myError += data.toString();
13  }
14};
15options.cwd = './lib';
16
17await exec.exec('node', ['index.js', 'foo=bar'], options);

Above code from actions/toolkit repository

Install

1$ npm install actions-exec-listener @actions/exec
2$ # or
3$ yarn add actions-exec-listener @actions/exec

Description

It can be used in the same way as @actions/exec, except for the return value.

Return values

require('actions-exec-listener').exec returns object containing the below keys.

• Extended from @actions/exec
  • stdout Buffer
  • stderr Buffer
  • stdline string
  • errline string
  • debug string
• Added by actions-exec-listener
  • stdoutStr
    • Returned value of stdout.toString().
  • stderrStr
    • Returned value of stderr.toString().

Contribution

PRs are accepted.

If you are having trouble or feature request, post new issue.