Skip to content

Commit e85adb2

Browse files
committed
docs: update the docs for exec-powershell [skip ci]
1 parent 10b6a5e commit e85adb2

File tree

3 files changed

+340
-7
lines changed

3 files changed

+340
-7
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@
114114
"patha": "^0.4.1",
115115
"prettier": "3.0.0",
116116
"prettier-config-atomic": "^3.1.0",
117+
"readme-md-generator": "^1.0.0",
117118
"retry-as-promised": "^7.0.4",
118119
"semver": "7.5.4",
119120
"setup-python": "github:aminya/setup-python#a783db655c6e40317e2c0c96f9d162d9c9f4a751",

packages/exec-powershell/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Asynchronously execute a powershell command.
2626

2727
- command (`string`) - The powershell command to execute
2828
- 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.
29-
- execOptions (`execa.Options`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
29+
- execOptions (`Options<string>`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
3030

31-
**returns:** execa.ExecaChildProcess<string>
31+
**returns:** ExecaChildProcess<string>
3232

3333
### `execPowershellSync` (function)
3434

@@ -38,9 +38,9 @@ Execute a powershell command.
3838

3939
- command (`string`) - The powershell command to execute
4040
- 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.
41-
- execOptions (`execaSyncOptions`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
41+
- execOptions (`SyncOptions<string>`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
4242

43-
**returns:** execa.ExecaSyncReturnValue<string>
43+
**returns:** ExecaReturnBase<string>
4444

4545
### `getPowerShell` (function)
4646

0 commit comments

Comments
 (0)