Skip to content

readline docs: adding events link #8475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

readline docs: adding events link #8475

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18807f7
doc: link SIGTSTP / SIGCONT events in readline doc
italoacasas Sep 10, 2016
add9579
fixing typos
italoacasas Sep 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc/api/readline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The `'pause'` event is emitted when one of the following occur:

* The `input` stream is paused.
* The `input` stream is not paused and receives the `SIGCONT` event. (See
events `SIGTSTP` and `SIGCONT`)
events [`SIGTSTP`][] and [`SIGCONT`][])

The listener function is called without passing any arguments.

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

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

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

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