diff options
author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-02 04:44:32 +0300 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-04 12:30:36 +0300 |
commit | 237cbe10fb82ba6ec69b14193a4a970e184306e7 (patch) | |
tree | 8fbbac215e1f9afcac524404e766c4157d8da145 /doc/api/readline.md | |
parent | f7049a20068dc8a7e904b7cdd3d5b307b595dd3a (diff) |
doc,tools: formalize, unify, codify default values
PR-URL: https://github.com/nodejs/node/pull/19737
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
-rw-r--r-- | doc/api/readline.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 2d6731ddb2a..a1411a621c7 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -357,22 +357,22 @@ changes: * `completer` {Function} An optional function used for Tab autocompletion. * `terminal` {boolean} `true` if the `input` and `output` streams should be treated like a TTY, and have ANSI/VT100 escape codes written to it. - Defaults to checking `isTTY` on the `output` stream upon instantiation. + **Default:** checking `isTTY` on the `output` stream upon instantiation. * `historySize` {number} Maximum number of history lines retained. To disable the history set this value to `0`. This option makes sense only if `terminal` is set to `true` by the user or by an internal `output` check, otherwise the history caching mechanism is not initialized at all. - **Default:** `30` - * `prompt` {string} The prompt string to use. **Default:** `'> '` + **Default:** `30`. + * `prompt` {string} The prompt string to use. **Default:** `'> '`. * `crlfDelay` {number} If the delay between `\r` and `\n` exceeds `crlfDelay` milliseconds, both `\r` and `\n` will be treated as separate end-of-line input. `crlfDelay` will be coerced to a number no less than `100`. It can be set to `Infinity`, in which case `\r` followed by `\n` will always be considered a single newline (which may be reasonable for - [reading files][] with `\r\n` line delimiter). **Default:** `100` + [reading files][] with `\r\n` line delimiter). **Default:** `100`. * `removeHistoryDuplicates` {boolean} If `true`, when a new input line added to the history list duplicates an older one, this removes the older line - from the list. **Default:** `false` + from the list. **Default:** `false`. The `readline.createInterface()` method creates a new `readline.Interface` instance. |