Skip to content

Commit 7105f8b

Browse files
Trottjuanarbol
authored andcommitted
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 <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
1 parent 1670266 commit 7105f8b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

lib/child_process.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ const MAX_BUFFER = 1024 * 1024;
9696
* @param {{
9797
* cwd?: string;
9898
* detached?: boolean;
99-
* env?: object;
99+
* env?: Record<string, string>;
100100
* execPath?: string;
101101
* execArgv?: string[];
102102
* gid?: number;
@@ -202,7 +202,7 @@ function normalizeExecArgs(command, options, callback) {
202202
* @param {string} command
203203
* @param {{
204204
* cmd?: string;
205-
* env?: object;
205+
* env?: Record<string, string>;
206206
* encoding?: string;
207207
* shell?: string;
208208
* signal?: AbortSignal;
@@ -256,7 +256,7 @@ ObjectDefineProperty(exec, promisify.custom, {
256256
* @param {string[]} [args]
257257
* @param {{
258258
* cwd?: string;
259-
* env?: object;
259+
* env?: Record<string, string>;
260260
* encoding?: string;
261261
* timeout?: number;
262262
* maxBuffer?: number;
@@ -673,7 +673,7 @@ function abortChildProcess(child, killSignal) {
673673
* @param {string[]} [args]
674674
* @param {{
675675
* cwd?: string;
676-
* env?: object;
676+
* env?: Record<string, string>;
677677
* argv0?: string;
678678
* stdio?: Array | string;
679679
* detached?: boolean;
@@ -746,7 +746,7 @@ function spawn(file, args, options) {
746746
* input?: string | Buffer | TypedArray | DataView;
747747
* argv0?: string;
748748
* stdio?: string | Array;
749-
* env?: object;
749+
* env?: Record<string, string>;
750750
* uid?: number;
751751
* gid?: number;
752752
* timeout?: number;
@@ -838,7 +838,7 @@ function checkExecSyncError(ret, args, cmd) {
838838
* cwd?: string;
839839
* input?: string | Buffer | TypedArray | DataView;
840840
* stdio?: string | Array;
841-
* env?: object;
841+
* env?: Record<string, string>;
842842
* uid?: number;
843843
* gid?: number;
844844
* timeout?: number;
@@ -875,7 +875,7 @@ function execFileSync(command, args, options) {
875875
* cwd?: string;
876876
* input?: string | Buffer | TypedArray | DataView;
877877
* stdio?: string | Array;
878-
* env?: object;
878+
* env?: Record<string, string>;
879879
* shell?: string;
880880
* uid?: number;
881881
* gid?: number;

0 commit comments

Comments
 (0)