ThunderNetworkRaD/readline-sync
2
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions

small change README.md

Browse source
This commit is contained in:
anseki 2014-08-10 18:16:08 +09:00
parent 931b17814a
commit 0e2b206e51
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,7 +1,7 @@
# readlineSync # readlineSync
Synchronous [Readline](http://nodejs.org/api/readline.html) for interactively running. Synchronous [Readline](http://nodejs.org/api/readline.html) for interactively running.
The interface is used with process.stdin and process.stdout in order to accept user input. The interface is used with `process.stdin` and `process.stdout` in order to accept user input.
## Example ## Example
@ -27,11 +27,13 @@ currentValue = readlineSync.setPrompt([prompt])
Sets the prompt, for example when you run `node` on the command line, you see `> `, which is node's prompt. Sets the prompt, for example when you run `node` on the command line, you see `> `, which is node's prompt.
`prompt` may be string, or may not be (e.g. number, Date, Object, etc.). This is converted to string (i.e. `toString` method is called) before it is displayed every time. `prompt` may be string, or may not be (e.g. number, Date, Object, etc.). This is converted to string (i.e. `toString` method is called) before it is displayed every time.
For example: `[foo-directory]# ` like bash For example: `[foo-directory]#` like a bash
```js ```js
readlineSync.setPrompt({toString: // Object that has toString method.
function() { return '[' + require('path').basename(process.cwd()) + ']# '; }}) readlineSync.setPrompt({toString: function() {
return '[' + require('path').basename(process.cwd()) + ']# ';
}})
``` ```
### prompt ### prompt