Skip to main content

execFileSync

function execFileSync
Jump to headingexecFileSync(file: string): Buffer

The child_process.execFileSync() method is generally identical to execFile with the exception that the method will not return until the child process has fully closed. When a timeout has been encountered and killSignal is sent, the method won't return until the process has completely exited.

If the child process intercepts and handles the SIGTERM signal and does not exit, the parent process will still wait until the child process has exited.

If the process times out or has a non-zero exit code, this method will throw an Error that will include the full result of the underlying spawnSync.

If the shell option is enabled, do not pass unsanitized user input to this function. Any input containing shell metacharacters may be used to trigger arbitrary command execution.

Parameters Jump to heading

Jump to headingfile: string

The name or path of the executable file to run.

Return Type Jump to heading

Buffer

The stdout from the command.

Jump to headingexecFileSync(
file: string,
): string | Buffer

Parameters Jump to heading

Return Type Jump to heading

string | Buffer
Jump to headingexecFileSync(
file: string,
args: readonly string[],
): Buffer

Parameters Jump to heading

Jump to headingfile: string
Jump to headingargs: readonly string[]

Return Type Jump to heading

Buffer
Jump to headingexecFileSync(
file: string,
args: readonly string[],
): string
Jump to headingexecFileSync(
file: string,
args: readonly string[],
): Buffer
Jump to headingexecFileSync(
file: string,
args?: readonly string[],
): string | Buffer

Parameters Jump to heading

Jump to headingfile: string
optional
Jump to headingargs: readonly string[]

Return Type Jump to heading

string | Buffer
Back to top