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

Fix: README

Browse source
This commit is contained in:
anseki 2015-05-23 13:56:40 +09:00
parent 146c05ccd4
commit 7b20ed4e72
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -410,6 +410,7 @@ Set the encoding method of the input and output.
### <a name="basic_options-buffersize"></a>`bufferSize` ### <a name="basic_options-buffersize"></a>`bufferSize`
_For `question*` and `prompt*` methods only_
*Type:* number *Type:* number
*Default:* `1024` *Default:* `1024`
@ -740,8 +741,8 @@ The following option has independent default value that is not affected by [Defa
The following options work as shown in the [Basic Options](#basic_options) section. The following options work as shown in the [Basic Options](#basic_options) section.
<table> <table>
<tr><td><a href="#basic_options-hideechoback"><code>hideEchoBack</code></a></td><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-defaultinput"><code>defaultInput</code></a></td><td><a href="#basic_options-casesensitive"><code>caseSensitive</code></a></td><td><a href="#basic_options-keepwhitespace"><code>keepWhitespace</code></a></td></tr> <tr><td><a href="#basic_options-hideechoback"><code>hideEchoBack</code></a></td><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-defaultinput"><code>defaultInput</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td></tr>
<tr><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td><td><a href="#basic_options-history"><code>history</code></a></td></tr> <tr><td><a href="#basic_options-print"><code>print</code></a></td><td><a href="#basic_options-history"><code>history</code></a></td></tr>
</table> </table>
### <a name="utility_methods-questionfloat"></a>`questionFloat` ### <a name="utility_methods-questionfloat"></a>`questionFloat`
@ -766,8 +767,8 @@ The following option has independent default value that is not affected by [Defa
The following options work as shown in the [Basic Options](#basic_options) section. The following options work as shown in the [Basic Options](#basic_options) section.
<table> <table>
<tr><td><a href="#basic_options-hideechoback"><code>hideEchoBack</code></a></td><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-defaultinput"><code>defaultInput</code></a></td><td><a href="#basic_options-casesensitive"><code>caseSensitive</code></a></td><td><a href="#basic_options-keepwhitespace"><code>keepWhitespace</code></a></td></tr> <tr><td><a href="#basic_options-hideechoback"><code>hideEchoBack</code></a></td><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-defaultinput"><code>defaultInput</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td></tr>
<tr><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td><td><a href="#basic_options-history"><code>history</code></a></td></tr> <tr><td><a href="#basic_options-print"><code>print</code></a></td><td><a href="#basic_options-history"><code>history</code></a></td></tr>
</table> </table>
### <a name="utility_methods-questionpath"></a>`questionPath` ### <a name="utility_methods-questionpath"></a>`questionPath`
@ -828,8 +829,7 @@ The following options have independent default value that is not affected by [De
The following options work as shown in the [Basic Options](#basic_options) section. The following options work as shown in the [Basic Options](#basic_options) section.
<table> <table>
<tr><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-defaultinput"><code>defaultInput</code></a></td><td><a href="#basic_options-casesensitive"><code>caseSensitive</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td></tr> <tr><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-defaultinput"><code>defaultInput</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr>
<tr><td><a href="#basic_options-print"><code>print</code></a></td></tr>
</table> </table>
And the following additional options are available. And the following additional options are available.
@ -1214,7 +1214,7 @@ if (readlineSync.keyInYN('Continue virus scan?') === false) {
The following options work as shown in the [Basic Options](#basic_options) section. The following options work as shown in the [Basic Options](#basic_options) section.
<table> <table>
<tr><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr> <tr><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr>
</table> </table>
And the following additional option is available. And the following additional option is available.
@ -1300,7 +1300,7 @@ The following option has independent default value that is not affected by [Defa
The following options work as shown in the [Basic Options](#basic_options) section. The following options work as shown in the [Basic Options](#basic_options) section.
<table> <table>
<tr><td><a href="#basic_options-casesensitive"><code>caseSensitive</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr> <tr><td><a href="#basic_options-casesensitive"><code>caseSensitive</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr>
</table> </table>
And the following additional option is available. And the following additional option is available.
@ -1366,7 +1366,7 @@ The following option has independent default value that is not affected by [Defa
The following options work as shown in the [Basic Options](#basic_options) section. The following options work as shown in the [Basic Options](#basic_options) section.
<table> <table>
<tr><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-buffersize"><code>bufferSize</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr> <tr><td><a href="#basic_options-mask"><code>mask</code></a></td><td><a href="#basic_options-encoding"><code>encoding</code></a></td><td><a href="#basic_options-print"><code>print</code></a></td></tr>
</table> </table>
And the following additional options are available. And the following additional options are available.

4
lib/readline-sync.js
View file

@ -923,7 +923,7 @@ function _questionNum(query, options, parser) {
// -------- forced // -------- forced
limit: getValidValue, limit: getValidValue,
cd: false cd: false
// trueValue, falseValue don't work. // trueValue, falseValue, caseSensitive, keepWhitespace don't work.
})); }));
return validValue; return validValue;
} }
@ -1008,7 +1008,7 @@ exports.questionPath = function(query, options) {
} }
return true; return true;
}, },
// trueValue, falseValue don't work. // trueValue, falseValue, caseSensitive don't work.
phContent: function(param) { phContent: function(param) {
return param === 'error' ? error : return param === 'error' ? error :
param !== 'min' && param !== 'max' ? null : param !== 'min' && param !== 'max' ? null :