setup-cpp/packages/exec-powershell
Amin Yahyaabadi 1865b24b57
docs: add readme for setup-apt and os-env
2024-08-16 02:01:51 -07:00
..
src fix: update dependencies 2023-07-24 13:20:13 -07:00
.eslintrc.json chore: add linting checks via turbo 2024-08-15 17:01:33 -07:00
README.md docs: update the docs for exec-powershell [skip ci] 2023-10-19 09:57:34 -07:00
package.json docs: add readme for setup-apt and os-env 2024-08-16 02:01:51 -07:00
tsconfig.json fix: add js file extension for all relative imports 2024-08-15 15:22:07 -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.