Skip to content

Commit c48cb2d

Browse files
italoacasasFishrock123
authored andcommitted
doc: link SIGTSTP / SIGCONT events in readline doc
PR-URL: #8475 Reviewed-By: Brian White <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent eff771f commit c48cb2d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/api/readline.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ The `'pause'` event is emitted when one of the following occur:
9090

9191
* The `input` stream is paused.
9292
* The `input` stream is not paused and receives the `SIGCONT` event. (See
93-
events `SIGTSTP` and `SIGCONT`)
93+
events [`SIGTSTP`][] and [`SIGCONT`][])
9494

9595
The listener function is called without passing any arguments.
9696

@@ -126,7 +126,7 @@ The `'SIGCONT'` event is emitted when a Node.js process previously moved into
126126
the background using `<ctrl>-Z` (i.e. `SIGTSTP`) is then brought back to the
127127
foreground using `fg(1)`.
128128

129-
If the `input` stream was paused *before* the `SIGSTP` request, this event will
129+
If the `input` stream was paused *before* the `SIGTSTP` request, this event will
130130
not be emitted.
131131

132132
The listener function is invoked without passing any arguments.
@@ -169,7 +169,7 @@ rl.on('SIGINT', () => {
169169
added: v0.7.5
170170
-->
171171

172-
The `'SIGTSPT'` event is emitted when the `input` stream receives a `<ctrl>-Z`
172+
The `'SIGTSTP'` event is emitted when the `input` stream receives a `<ctrl>-Z`
173173
input, typically known as `SIGTSTP`. If there are no `SIGTSTP` event listeners
174174
registered when the `input` stream receives a `SIGTSTP`, the Node.js process
175175
will be sent to the background.
@@ -523,3 +523,5 @@ rl.on('line', (line) => {
523523
[Writable]: stream.html
524524
[Readable]: stream.html
525525
[TTY]: tty.html
526+
[`SIGTSTP`]: readline.html#readline_event_sigtstp
527+
[`SIGCONT`]: readline.html#readline_event_sigcont

0 commit comments

Comments
 (0)