Skip to content

Commit 278450f

Browse files
Trottevanlucas
authored andcommitted
doc: multiple updates to child_process.md
* use serial comma in child_process.md * use American spelling of unsanitized in child_process.md * hyphenate general-purpose in child_process.md * remove errant commas in child_process.md PR-URL: #17990 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent dd72f9c commit 278450f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/api/child_process.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ls.on('close', (code) => {
2525
});
2626
```
2727

28-
By default, pipes for `stdin`, `stdout` and `stderr` are established between
28+
By default, pipes for `stdin`, `stdout`, and `stderr` are established between
2929
the parent Node.js process and the spawned child. It is possible to stream data
3030
through these pipes in a non-blocking way. *Note, however, that some programs
3131
use line-buffered I/O internally. While that does not affect Node.js, it can
@@ -170,7 +170,7 @@ exec('echo "The \\$HOME variable is $HOME"');
170170
//The $HOME variable is escaped in the first instance, but not in the second
171171
```
172172

173-
*Note*: Never pass unsanitised user input to this function. Any input
173+
*Note*: Never pass unsanitized user input to this function. Any input
174174
containing shell metacharacters may be used to trigger arbitrary command
175175
execution.
176176

@@ -418,7 +418,7 @@ The `child_process.spawn()` method spawns a new process using the given
418418
`command`, with command line arguments in `args`. If omitted, `args` defaults
419419
to an empty array.
420420

421-
*Note*: If the `shell` option is enabled, do not pass unsanitised user input to
421+
*Note*: If the `shell` option is enabled, do not pass unsanitized user input to
422422
this function. Any input containing shell metacharacters may be used to
423423
trigger arbitrary command execution.
424424

@@ -661,7 +661,7 @@ The [`child_process.spawnSync()`][], [`child_process.execSync()`][], and
661661
the Node.js event loop, pausing execution of any additional code until the
662662
spawned process exits.
663663

664-
Blocking calls like these are mostly useful for simplifying general purpose
664+
Blocking calls like these are mostly useful for simplifying general-purpose
665665
scripting tasks and for simplifying the loading/processing of application
666666
configuration at startup.
667667

@@ -715,7 +715,7 @@ completely exited.
715715
does not exit, the parent process will still wait until the child process has
716716
exited.
717717

718-
If the process times out, or has a non-zero exit code, this method ***will***
718+
If the process times out or has a non-zero exit code, this method ***will***
719719
throw an [`Error`][] that will include the full result of the underlying
720720
[`child_process.spawnSync()`][].
721721

@@ -767,11 +767,11 @@ exited. *Note that if the child process intercepts and handles the `SIGTERM`
767767
signal and doesn't exit, the parent process will wait until the child
768768
process has exited.*
769769

770-
If the process times out, or has a non-zero exit code, this method ***will***
770+
If the process times out or has a non-zero exit code, this method ***will***
771771
throw. The [`Error`][] object will contain the entire result from
772772
[`child_process.spawnSync()`][]
773773

774-
*Note*: Never pass unsanitised user input to this function. Any input
774+
*Note*: Never pass unsanitized user input to this function. Any input
775775
containing shell metacharacters may be used to trigger arbitrary command
776776
execution.
777777

@@ -839,7 +839,7 @@ completely exited. Note that if the process intercepts and handles the
839839
`SIGTERM` signal and doesn't exit, the parent process will wait until the child
840840
process has exited.
841841

842-
*Note*: If the `shell` option is enabled, do not pass unsanitised user input
842+
*Note*: If the `shell` option is enabled, do not pass unsanitized user input
843843
to this function. Any input containing shell metacharacters may be used to
844844
trigger arbitrary command execution.
845845

0 commit comments

Comments
 (0)