docs: update the docs for exec-powershell [skip ci]

aminya · Oct 19, 2023 · e85adb2 · e85adb2
1 parent 10b6a5e
commit e85adb2
Show file tree

Hide file tree

Showing 3 changed files with 340 additions and 7 deletions.
diff --git a/package.json b/package.json
@@ -114,6 +114,7 @@
     "patha": "^0.4.1",
     "prettier": "3.0.0",
     "prettier-config-atomic": "^3.1.0",
+    "readme-md-generator": "^1.0.0",
     "retry-as-promised": "^7.0.4",
     "semver": "7.5.4",
     "setup-python": "github:aminya/setup-python#a783db655c6e40317e2c0c96f9d162d9c9f4a751",

diff --git a/packages/exec-powershell/README.md b/packages/exec-powershell/README.md
@@ -26,9 +26,9 @@ Asynchronously execute a powershell command.
 
 - 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 (`execa.Options`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
+- execOptions (`Options<string>`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
 
-**returns:** execa.ExecaChildProcess<string>
+**returns:** ExecaChildProcess<string>
 
 ### `execPowershellSync` (function)
 
@@ -38,9 +38,9 @@ Execute a powershell command.
 
 - 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 (`execaSyncOptions`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
+- execOptions (`SyncOptions<string>`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
 
-**returns:** execa.ExecaSyncReturnValue<string>
+**returns:** ExecaReturnBase<string>
 
 ### `getPowerShell` (function)