Skip to content

Commit

Permalink
Update README.md (#464)
Browse files Browse the repository at this point in the history
Added missing documentation for `pageSize`
#439
  • Loading branch information
ntwcklng authored and SBoudrias committed Nov 25, 2016
1 parent dcc5c6d commit 081b7af
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Array values can be simple `strings`, or `objects` containing a `name` (to displ
- **validate**: (Function) Receive the user input and should return `true` if the value is valid, and an error message (`String`) otherwise. If `false` is returned, a default error message is provided.
- **filter**: (Function) Receive the user input and return the filtered value to be used inside the program. The value returned will be added to the _Answers_ hash.
- **when**: (Function, Boolean) Receive the current user answers hash and should return `true` or `false` depending on whether or not this question should be asked. The value can also be a simple boolean.
- **pageSize**: (Number) Change the number of lines that will be rendered when using `list`, `rawList`, `expand` or `checkbox`.

`default`, `choices`(if defined as functions), `validate`, `filter` and `when` functions can be called asynchronous. Either return a promise or use `this.async()` to get a callback you'll call with the final value.

Expand Down

0 comments on commit 081b7af

Please sign in to comment.