Commit 687b853
child_process: add env contents types in JSDoc
Use JSDoc to indicate that the `env` object keys and values must be
strings.
Refs: #42489 (comment)
PR-URL: #42494
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>1 parent b238396 commit 687b853
1 file changed
Lines changed: 7 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -96,7 +96,7 @@ const MAX_BUFFER = 1024 * 1024; | |||
| 96 | 96 | * @param {{ | |
| 97 | 97 | * cwd?: string; | |
| 98 | 98 | * detached?: boolean; | |
| 99 | - * env?: object; | ||
| 99 | + * env?: Record<string, string>; | ||
| 100 | 100 | * execPath?: string; | |
| 101 | 101 | * execArgv?: string[]; | |
| 102 | 102 | * gid?: number; | |
@@ -202,7 +202,7 @@ function normalizeExecArgs(command, options, callback) { | |||
| 202 | 202 | * @param {string} command | |
| 203 | 203 | * @param {{ | |
| 204 | 204 | * cmd?: string; | |
| 205 | - * env?: object; | ||
| 205 | + * env?: Record<string, string>; | ||
| 206 | 206 | * encoding?: string; | |
| 207 | 207 | * shell?: string; | |
| 208 | 208 | * signal?: AbortSignal; | |
@@ -256,7 +256,7 @@ ObjectDefineProperty(exec, promisify.custom, { | |||
| 256 | 256 | * @param {string[]} [args] | |
| 257 | 257 | * @param {{ | |
| 258 | 258 | * cwd?: string; | |
| 259 | - * env?: object; | ||
| 259 | + * env?: Record<string, string>; | ||
| 260 | 260 | * encoding?: string; | |
| 261 | 261 | * timeout?: number; | |
| 262 | 262 | * maxBuffer?: number; | |
@@ -673,7 +673,7 @@ function abortChildProcess(child, killSignal) { | |||
| 673 | 673 | * @param {string[]} [args] | |
| 674 | 674 | * @param {{ | |
| 675 | 675 | * cwd?: string; | |
| 676 | - * env?: object; | ||
| 676 | + * env?: Record<string, string>; | ||
| 677 | 677 | * argv0?: string; | |
| 678 | 678 | * stdio?: Array | string; | |
| 679 | 679 | * detached?: boolean; | |
@@ -746,7 +746,7 @@ function spawn(file, args, options) { | |||
| 746 | 746 | * input?: string | Buffer | TypedArray | DataView; | |
| 747 | 747 | * argv0?: string; | |
| 748 | 748 | * stdio?: string | Array; | |
| 749 | - * env?: object; | ||
| 749 | + * env?: Record<string, string>; | ||
| 750 | 750 | * uid?: number; | |
| 751 | 751 | * gid?: number; | |
| 752 | 752 | * timeout?: number; | |
@@ -838,7 +838,7 @@ function checkExecSyncError(ret, args, cmd) { | |||
| 838 | 838 | * cwd?: string; | |
| 839 | 839 | * input?: string | Buffer | TypedArray | DataView; | |
| 840 | 840 | * stdio?: string | Array; | |
| 841 | - * env?: object; | ||
| 841 | + * env?: Record<string, string>; | ||
| 842 | 842 | * uid?: number; | |
| 843 | 843 | * gid?: number; | |
| 844 | 844 | * timeout?: number; | |
@@ -875,7 +875,7 @@ function execFileSync(command, args, options) { | |||
| 875 | 875 | * cwd?: string; | |
| 876 | 876 | * input?: string | Buffer | TypedArray | DataView; | |
| 877 | 877 | * stdio?: string | Array; | |
| 878 | - * env?: object; | ||
| 878 | + * env?: Record<string, string>; | ||
| 879 | 879 | * shell?: string; | |
| 880 | 880 | * uid?: number; | |
| 881 | 881 | * gid?: number; | |
0 commit comments