actions
/
setup-cpp
Template
mirror of https://github.com/aminya/setup-cpp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
setup-cpp/packages/exec-powershell
History
Amin Yahyaabadi e85adb2ac6 docs: update the docs for exec-powershell [skip ci] 2023-10-19 09:57:34 -07:00
..
src fix: update dependencies 2023-07-24 13:20:13 -07:00
README.md docs: update the docs for exec-powershell [skip ci] 2023-10-19 09:57:34 -07:00
package.json fix: use node 20 instead of node 18 2023-07-15 15:41:58 -07:00
tsconfig.json feat: add exec-powershell package 2022-08-07 16:59:24 -07:00

README.md

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.