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-07-13 14:24:37 +09:00
parent 6e2b8c8d3f
commit 1d34fb7828
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -26,7 +26,7 @@ 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.
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: like bash `[foo-directory]# ` For example: like bash `[foo-directory]# `
```js ```js
@ -41,7 +41,7 @@ line = readlineSync.prompt([options])
``` ```
Readies readline for input from the user, putting the current `setPrompt` options on a new line, giving the user a new spot to write. Readies readline for input from the user, putting the current `setPrompt` options on a new line, giving the user a new spot to write.
If `{noEchoBack: true}` is specified to `options`, echo back is avoided. It is used to hide the password which is typed by user on screen. If `{noEchoBack: true}` is specified to `options`, echo back is avoided. It is used to hide the secret text (e.g. password) which is typed by user on screen.
### question ### question
@ -50,8 +50,8 @@ line = readlineSync.question([query[, options]])
``` ```
Displays the `query` to the user, and then returns the user's response after it has been typed. Displays the `query` to the user, and then returns the user's response after it has been typed.
`query` is converted to string (i.e. `toString` method is called) before it is displayed every time. `query` 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.
If `{noEchoBack: true}` is specified to `options`, echo back is avoided. It is used to hide the password which is typed by user on screen. If `{noEchoBack: true}` is specified to `options`, echo back is avoided. It is used to hide the secret text (e.g. password) which is typed by user on screen.
### setEncoding ### setEncoding