Type alias CLITestOptions

CLITestOptions: {
    failOnStderr?: boolean;
    outputEncoding?: BufferEncoding;
    process?: {
        cwd?: string;
        env?: NodeJS.ProcessEnv;
        gid?: number;
        timeout?: number;
        uid?: number;
    };
}

Additonal options that can be passed to the CLITest constructor.

Type declaration

  • Optional failOnStderr?: boolean

    Throw an error if the process writes to stderr.

    Default

    true
  • Optional outputEncoding?: BufferEncoding

    The encoding to use for decoding the output.

    Default

    'utf-8'
  • Optional process?: {
        cwd?: string;
        env?: NodeJS.ProcessEnv;
        gid?: number;
        timeout?: number;
        uid?: number;
    }
    • Optional cwd?: string

      Current working directory of the process to be spawned.

    • Optional env?: NodeJS.ProcessEnv

      Pass environment variables to the cli process.

      Default

      process.env
    • Optional gid?: number

      Sets the group identity of the process.

    • Optional timeout?: number

      The maximum amount of time the process is allowed to run in milliseconds.

      Default

      undefined
    • Optional uid?: number

      Sets the user identity of the process.

Settings

Member Visibility

Theme

Generated using TypeDoc