setup-cpp/packages/exec-powershell/README.md

1.8 KiB

exec-powershell

Version License: Apache--2.0

Run a powershell command.

Install

npm install --save exec-powershell

Usage

execPowershell (function)

Asynchronously execute a powershell command.

Parameters:

  • command (string) - The powershell command to execute
  • startupFlags (string[]) - The optional startup flags to be passed to powershell. Defaults to ["-NoProfile", "-NoLogo", "-NonInteractive"]. This means that the Powershell profile is not sourced first.
  • execOptions (Options<string>) - The options passed to execa. Defaults to { stdio: "inherit" }

returns: ExecaChildProcess

execPowershellSync (function)

Execute a powershell command.

Parameters:

  • command (string) - The powershell command to execute
  • startupFlags (string[]) - The optional startup flags to be passed to powershell. Defaults to ["-NoProfile", "-NoLogo", "-NonInteractive"]. This means that the Powershell profile is not sourced first.
  • execOptions (SyncOptions<string>) - The options passed to execa. Defaults to { stdio: "inherit" }

returns: ExecaReturnBase

getPowerShell (function)

Get the path to the powershell executable.

returns: string

🤝 Contributing

You can sponsor my work here:

https://github.com/sponsors/aminya

Pull requests, issues and feature requests are welcome. See the Contributing guide.