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