diff options
author | Rich Trott <rtrott@gmail.com> | 2019-10-24 07:28:42 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-10-26 18:39:41 +0300 |
commit | 10040500da6af33b602e35c3f3bbe28cf76c4c4a (patch) | |
tree | 69c2af94709de9ef7022c41423c0f618eb0d5e0a /doc/api/repl.md | |
parent | 6858c7e3e7c30986d68a683d3d5e4ede4c0b529f (diff) |
doc: remove dashes
The use of dashes -- in general, but especially in our docs -- can be
problematic. It is used inconsistently and there is always another form
of punctuation that is as good or better for the situation. In an effort
to reduce the number of variations we use to display the same types of
information, remove the various uses of dashes from the documentation.
PR-URL: https://github.com/nodejs/node/pull/30101
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/repl.md')
-rw-r--r-- | doc/api/repl.md | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/api/repl.md b/doc/api/repl.md index 81620e0e9b4..cd7edb59ddf 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -29,18 +29,18 @@ customizable evaluation functions. The following special commands are supported by all REPL instances: -* `.break` - When in the process of inputting a multi-line expression, entering +* `.break`: When in the process of inputting a multi-line expression, entering the `.break` command (or pressing the `<ctrl>-C` key combination) will abort further input or processing of that expression. -* `.clear` - Resets the REPL `context` to an empty object and clears any +* `.clear`: Resets the REPL `context` to an empty object and clears any multi-line expression currently being input. -* `.exit` - Close the I/O stream, causing the REPL to exit. -* `.help` - Show this list of special commands. -* `.save` - Save the current REPL session to a file: +* `.exit`: Close the I/O stream, causing the REPL to exit. +* `.help`: Show this list of special commands. +* `.save`: Save the current REPL session to a file: `> .save ./file/to/save.js` -* `.load` - Load a file into the current REPL session. +* `.load`: Load a file into the current REPL session. `> .load ./file/to/load.js` -* `.editor` - Enter editor mode (`<ctrl>-D` to finish, `<ctrl>-C` to cancel). +* `.editor`: Enter editor mode (`<ctrl>-D` to finish, `<ctrl>-C` to cancel). ```console > .editor @@ -58,11 +58,11 @@ welcome('Node.js User'); The following key combinations in the REPL have these special effects: -* `<ctrl>-C` - When pressed once, has the same effect as the `.break` command. +* `<ctrl>-C`: When pressed once, has the same effect as the `.break` command. When pressed twice on a blank line, has the same effect as the `.exit` command. -* `<ctrl>-D` - Has the same effect as the `.exit` command. -* `<tab>` - When pressed on a blank line, displays global and local (scope) +* `<ctrl>-D`: Has the same effect as the `.exit` command. +* `<tab>`: When pressed on a blank line, displays global and local (scope) variables. When pressed while entering other input, displays relevant autocompletion options. @@ -557,12 +557,12 @@ changes: * `replMode` {symbol} A flag that specifies whether the default evaluator executes all JavaScript commands in strict mode or default (sloppy) mode. Acceptable values are: - * `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode. - * `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is + * `repl.REPL_MODE_SLOPPY` to evaluate expressions in sloppy mode. + * `repl.REPL_MODE_STRICT` to evaluate expressions in strict mode. This is equivalent to prefacing every repl statement with `'use strict'`. - * `breakEvalOnSigint` - Stop evaluating the current piece of code when - `SIGINT` is received, i.e. `Ctrl+C` is pressed. This cannot be used together - with a custom `eval` function. **Default:** `false`. + * `breakEvalOnSigint` {boolean} Stop evaluating the current piece of code when + `SIGINT` is received, such as when `Ctrl+C` is pressed. This cannot be used + together with a custom `eval` function. **Default:** `false`. * Returns: {repl.REPLServer} The `repl.start()` method creates and starts a [`repl.REPLServer`][] instance. @@ -601,16 +601,16 @@ undefined Various behaviors of the Node.js REPL can be customized using the following environment variables: -* `NODE_REPL_HISTORY` - When a valid path is given, persistent REPL history +* `NODE_REPL_HISTORY`: When a valid path is given, persistent REPL history will be saved to the specified file rather than `.node_repl_history` in the user's home directory. Setting this value to `''` (an empty string) will disable persistent REPL history. Whitespace will be trimmed from the value. On Windows platforms environment variables with empty values are invalid so set this variable to one or more spaces to disable persistent REPL history. -* `NODE_REPL_HISTORY_SIZE` - Controls how many lines of history will be +* `NODE_REPL_HISTORY_SIZE`: Controls how many lines of history will be persisted if history is available. Must be a positive number. **Default:** `1000`. -* `NODE_REPL_MODE` - May be either `'sloppy'` or `'strict'`. **Default:** +* `NODE_REPL_MODE`: May be either `'sloppy'` or `'strict'`. **Default:** `'sloppy'`, which will allow non-strict mode code to be run. ### Persistent History |