From 50cb3a3711e1f9d522f7d0865c41546d6857b847 Mon Sep 17 00:00:00 2001 From: Vse Mozhet Byt Date: Sun, 11 Dec 2016 01:22:04 +0200 Subject: [PATCH] doc: document argument variant in the repl.md `options` in the `repl.start([options])` can be a string. Ref: https://github.com/nodejs/node/pull/10160 PR-URL: https://github.com/nodejs/node/pull/10221 Reviewed-By: Benjamin Gruenbaum --- doc/api/repl.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/api/repl.md b/doc/api/repl.md index b78a13544add4a..9ff416e004f4b3 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -371,7 +371,7 @@ within the action function for commands registered using the added: v0.1.91 --> -* `options` {Object} +* `options` {Object | String} * `prompt` {String} The input prompt to display. Defaults to `> `. * `input` {Readable} The Readable stream from which REPL input will be read. Defaults to `process.stdin`. @@ -413,6 +413,15 @@ added: v0.1.91 The `repl.start()` method creates and starts a `repl.REPLServer` instance. +If `options` is a string, then it specifies the input prompt: + +```js +const repl = require('repl'); + +// a Unix style prompt +repl.start('$ '); +``` + ## The Node.js REPL Node.js itself uses the `repl` module to provide its own interactive interface