Skip to content

Commit

Permalink
doc: fully document --experimental-repl-await
Browse files Browse the repository at this point in the history
PR-URL: #20133
Fixes: #19604 (comment)
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
TimothyGu authored and jasnell committed Apr 19, 2018
1 parent c31f0d0 commit 56d6e82
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
8 changes: 8 additions & 0 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@ added: v8.5.0
Enable experimental ES module support and caching modules.


### `--experimental-repl-await`
<!-- YAML
added: REPLACEME
-->

Enable experimental top-level `await` keyword support in REPL.


### `--experimental-vm-modules`
<!-- YAML
added: v9.6.0
Expand Down
3 changes: 2 additions & 1 deletion doc/api/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Error: foo

#### `await` keyword

With the `--experimental-repl-await` command line option specified,
With the [`--experimental-repl-await`][] command line option specified,
experimental support for the `await` keyword is enabled.

<!-- eslint-skip -->
Expand Down Expand Up @@ -612,6 +612,7 @@ a `net.Server` and `net.Socket` instance, see: https://gist.github.com/2209310
For an example of running a REPL instance over [curl(1)][],
see: https://gist.github.com/2053342

[`--experimental-repl-await`]: cli.html#cli_experimental_repl_await
[`readline.InterfaceCompleter`]: readline.html#readline_use_of_the_completer_function
[`readline.Interface`]: readline.html#readline_class_interface
[`util.inspect()`]: util.html#util_util_inspect_object_options
Expand Down
5 changes: 5 additions & 0 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ Requires Node.js to be built with
.It Fl \-experimental-modules
Enable experimental ES module support and caching modules.
.
.It Fl \-experimental-repl-await
Enable experimental top-level
.Sy await
keyword support in REPL.
.
.It Fl \-experimental-vm-modules
Enable experimental ES module support in VM module.
.
Expand Down

0 comments on commit 56d6e82

Please sign in to comment.