github.com/jfrog/frogbot@v1.1.1-0.20231221090046-821a26f50338/action/node_modules/@actions/exec/lib/interfaces.d.ts (about)

     1  /// <reference types="node" />
     2  import * as stream from 'stream';
     3  /**
     4   * Interface for exec options
     5   */
     6  export interface ExecOptions {
     7      /** optional working directory.  defaults to current */
     8      cwd?: string;
     9      /** optional envvar dictionary.  defaults to current process's env */
    10      env?: {
    11          [key: string]: string;
    12      };
    13      /** optional.  defaults to false */
    14      silent?: boolean;
    15      /** optional out stream to use. Defaults to process.stdout */
    16      outStream?: stream.Writable;
    17      /** optional err stream to use. Defaults to process.stderr */
    18      errStream?: stream.Writable;
    19      /** optional. whether to skip quoting/escaping arguments if needed.  defaults to false. */
    20      windowsVerbatimArguments?: boolean;
    21      /** optional.  whether to fail if output to stderr.  defaults to false */
    22      failOnStdErr?: boolean;
    23      /** optional.  defaults to failing on non zero.  ignore will not fail leaving it up to the caller */
    24      ignoreReturnCode?: boolean;
    25      /** optional. How long in ms to wait for STDIO streams to close after the exit event of the process before terminating. defaults to 10000 */
    26      delay?: number;
    27      /** optional. input to write to the process on STDIN. */
    28      input?: Buffer;
    29      /** optional. Listeners for output. Callback functions that will be called on these events */
    30      listeners?: ExecListeners;
    31  }
    32  /**
    33   * Interface for the output of getExecOutput()
    34   */
    35  export interface ExecOutput {
    36      /**The exit code of the process */
    37      exitCode: number;
    38      /**The entire stdout of the process as a string */
    39      stdout: string;
    40      /**The entire stderr of the process as a string */
    41      stderr: string;
    42  }
    43  /**
    44   * The user defined listeners for an exec call
    45   */
    46  export interface ExecListeners {
    47      /** A call back for each buffer of stdout */
    48      stdout?: (data: Buffer) => void;
    49      /** A call back for each buffer of stderr */
    50      stderr?: (data: Buffer) => void;
    51      /** A call back for each line of stdout */
    52      stdline?: (data: string) => void;
    53      /** A call back for each line of stderr */
    54      errline?: (data: string) => void;
    55      /** A call back for each debug log */
    56      debug?: (data: string) => void;
    57  }