summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTimothy Gu <timothygu99@gmail.com>2018-04-18 08:50:35 -0700
committerTimothy Gu <timothygu99@gmail.com>2018-04-18 14:12:39 -0700
commitceab78f9d8738b0a0036aeb59fe973459cf529b2 (patch)
treef45aa5501ed8b27f1b35f9eafaed33f97da5d471 /doc
parent52491529ba940faa6d69b20bb5fe89ae3b3e137c (diff)
downloadandroid-node-v8-ceab78f9d8738b0a0036aeb59fe973459cf529b2.tar.gz
android-node-v8-ceab78f9d8738b0a0036aeb59fe973459cf529b2.tar.bz2
android-node-v8-ceab78f9d8738b0a0036aeb59fe973459cf529b2.zip
doc: fully document --experimental-repl-await
PR-URL: https://github.com/nodejs/node/pull/20133 Fixes: https://github.com/nodejs/node/pull/19604#issuecomment-382427090 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>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/cli.md8
-rw-r--r--doc/api/repl.md3
-rw-r--r--doc/node.15
3 files changed, 15 insertions, 1 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md
index 7c06056fad..97edf0f4b2 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -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
diff --git a/doc/api/repl.md b/doc/api/repl.md
index 3a5134d1e2..46cac0df3e 100644
--- a/doc/api/repl.md
+++ b/doc/api/repl.md
@@ -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 -->
@@ -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
diff --git a/doc/node.1 b/doc/node.1
index 710487cb86..24d8260b87 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -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.
.