You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add documentation for the windowsVerbatimArguments option that's supported
by @npmcli/promise-spawn but was previously undocumented in our wrapper.
This option disables argument quoting/escaping on Windows when shell: true
is used, allowing exact control over argument formatting. Useful for advanced
shell command scenarios on Windows.
Also sorted JSDoc @Property declarations alphabetically for consistency.
* @property {number | undefined} timeout - Maximum time in milliseconds before killing the process
79
80
* @property {number | undefined} uid - User identity of the process (POSIX only)
80
-
* @property {number | undefined} gid - Group identity of the process (POSIX only)
81
+
* @property {boolean | undefined} windowsVerbatimArguments - Don't quote or escape arguments on Windows (requires shell: true). Use when you need exact argument control. Default: false
81
82
*/
82
83
exporttypePromiseSpawnOptions={
83
84
cwd?: string|undefined
@@ -89,6 +90,7 @@ export type PromiseSpawnOptions = {
* @property {number | undefined} timeout - Timeout in milliseconds
425
428
* @property {number | undefined} uid - User identity (POSIX)
426
-
* @property {number | undefined} gid - Group identity (POSIX)
429
+
* @property {boolean | undefined} windowsVerbatimArguments - Don't quote or escape arguments on Windows (requires shell: true). Use when you need exact argument control. Default: false
0 commit comments