Browse Source

doc: change `in` to `input` in the readline docs

Also compacting some long lines.
v0.9.1-release
Nathan Rajlich 13 years ago
parent
commit
86bd9b6e70
  1. 56
      doc/api/readline.markdown

56
doc/api/readline.markdown

@ -35,9 +35,9 @@ the following values:
- `completer` - an optional function that is used for Tab autocompletion. See - `completer` - an optional function that is used for Tab autocompletion. See
below for an example of using this. below for an example of using this.
- `terminal` - pass `true` if the `input` and `output` streams should be treated - `terminal` - pass `true` if the `input` and `output` streams should be
like a TTY, and have ANSI/VT100 escape codes written to it. Defaults to treated like a TTY, and have ANSI/VT100 escape codes written to it.
checking `isTTY` on the `output` stream upon instantiation. Defaults to checking `isTTY` on the `output` stream upon instantiation.
The `completer` function is given a the current line entered by the user, and The `completer` function is given a the current line entered by the user, and
is supposed to return an Array with 2 entries: is supposed to return an Array with 2 entries:
@ -64,10 +64,11 @@ Also `completer` can be run in async mode if it accepts two arguments:
output: process.stdout output: process.stdout
}); });
Once you have a readline instance, you most commonly listen for the `"line"` event. Once you have a readline instance, you most commonly listen for the
`"line"` event.
If `terminal` is `true` for this instance then the `output` stream will get the If `terminal` is `true` for this instance then the `output` stream will get
best compatability if it defines an `output.columns` property, and fires the best compatability if it defines an `output.columns` property, and fires
a `"resize"` event on the `output` if/when the columns ever change a `"resize"` event on the `output` if/when the columns ever change
(`process.stdout` does this automatically when it is a TTY). (`process.stdout` does this automatically when it is a TTY).
@ -86,17 +87,17 @@ Sets the prompt, for example when you run `node` on the command line, you see
Readies readline for input from the user, putting the current `setPrompt` Readies readline for input from the user, putting the current `setPrompt`
options on a new line, giving the user a new spot to write. options on a new line, giving the user a new spot to write.
This will also resume the `in` stream used with `createInterface` if it has This will also resume the `input` stream used with `createInterface` if it has
been paused. been paused.
### rl.question(query, callback) ### rl.question(query, callback)
Prepends the prompt with `query` and invokes `callback` with the user's Prepends the prompt with `query` and invokes `callback` with the user's
response. Displays the query to the user, and then invokes `callback` with the response. Displays the query to the user, and then invokes `callback`
user's response after it has been typed. with the user's response after it has been typed.
This will also resume the `in` stream used with `createInterface` if it has This will also resume the `input` stream used with `createInterface` if
been paused. it has been paused.
Example usage: Example usage:
@ -122,7 +123,7 @@ This will also resume the `input` stream if it has been paused.
`function (line) {}` `function (line) {}`
Emitted whenever the `in` stream receives a `\n`, usually received when the Emitted whenever the `input` stream receives a `\n`, usually received when the
user hits enter, or return. This is a good hook to listen for user input. user hits enter, or return. This is a good hook to listen for user input.
Example of listening for `line`: Example of listening for `line`:
@ -135,12 +136,13 @@ Example of listening for `line`:
`function () {}` `function () {}`
Emitted whenever the `in` stream is paused or receives `^D`, respectively known Emitted whenever the `input` stream is paused or receives `^D`, respectively
as `EOT`. This event is also called if there is no `SIGINT` event listener known as `EOT`. This event is also called if there is no `SIGINT` event
present when the `in` stream receives a `^C`, respectively known as `SIGINT`. listener present when the `input` stream receives a `^C`, respectively known
as `SIGINT`.
Also emitted whenever the `in` stream is not paused and receives the `SIGCONT` Also emitted whenever the `input` stream is not paused and receives the
event. (See events `SIGTSTP` and `SIGCONT`) `SIGCONT` event. (See events `SIGTSTP` and `SIGCONT`)
Example of listening for `pause`: Example of listening for `pause`:
@ -152,7 +154,7 @@ Example of listening for `pause`:
`function () {}` `function () {}`
Emitted whenever the `in` stream is resumed. Emitted whenever the `input` stream is resumed.
Example of listening for `resume`: Example of listening for `resume`:
@ -172,9 +174,9 @@ instance as completed after this is emitted.
`function () {}` `function () {}`
Emitted whenever the `in` stream receives a `^C`, respectively known as Emitted whenever the `input` stream receives a `^C`, respectively known as
`SIGINT`. If there is no `SIGINT` event listener present when the `in` stream `SIGINT`. If there is no `SIGINT` event listener present when the `input`
receives a `SIGINT`, `pause` will be triggered. stream receives a `SIGINT`, `pause` will be triggered.
Example of listening for `SIGINT`: Example of listening for `SIGINT`:
@ -190,9 +192,9 @@ Example of listening for `SIGINT`:
**This does not work on Windows.** **This does not work on Windows.**
Emitted whenever the `in` stream receives a `^Z`, respectively known as Emitted whenever the `input` stream receives a `^Z`, respectively known as
`SIGTSTP`. If there is no `SIGTSTP` event listener present when the `in` stream `SIGTSTP`. If there is no `SIGTSTP` event listener present when the `input`
receives a `SIGTSTP`, the program will be sent to the background. stream receives a `SIGTSTP`, the program will be sent to the background.
When the program is resumed with `fg`, the `pause` and `SIGCONT` events will be When the program is resumed with `fg`, the `pause` and `SIGCONT` events will be
emitted. You can use either to resume the stream. emitted. You can use either to resume the stream.
@ -214,9 +216,9 @@ Example of listening for `SIGTSTP`:
**This does not work on Windows.** **This does not work on Windows.**
Emitted whenever the `in` stream is sent to the background with `^Z`, Emitted whenever the `input` stream is sent to the background with `^Z`,
respectively known as `SIGTSTP`, and then continued with `fg`. This event only respectively known as `SIGTSTP`, and then continued with `fg(1)`. This event
emits if the stream was not paused before sending the program to the only emits if the stream was not paused before sending the program to the
background. background.
Example of listening for `SIGCONT`: Example of listening for `SIGCONT`:

Loading…
Cancel
Save