Updating NPM dependencies
This commit is contained in:
16
node_modules/prompts/readme.md
generated
vendored
16
node_modules/prompts/readme.md
generated
vendored
@@ -22,8 +22,8 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<b>Lightweight, beautiful and user-friendly interactive prompts</b></br>
|
||||
<sub>>_ Easy to use CLI prompts to enquire users for information▌<sub>
|
||||
<b>Lightweight, beautiful and user-friendly interactive prompts</b><br />
|
||||
<sub>>_ Easy to use CLI prompts to enquire users for information▌</sub>
|
||||
</p>
|
||||
|
||||
<br />
|
||||
@@ -316,6 +316,8 @@ Almost all prompt objects have the following properties:
|
||||
format: Function | Async Function,
|
||||
onRender: Function
|
||||
onState: Function
|
||||
stdin: Readable
|
||||
stdout: Writeable
|
||||
}
|
||||
```
|
||||
|
||||
@@ -417,6 +419,13 @@ Callback for when the state of the current prompt changes.
|
||||
The function signature is `(state)` where `state` is an object with a snapshot of the current state.
|
||||
The state object has two properties `value` and `aborted`. E.g `{ value: 'This is ', aborted: false }`
|
||||
|
||||
### stdin and stdout
|
||||
|
||||
Type: `Stream`
|
||||
|
||||
By default, prompts uses `process.stdin` for receiving input and `process.stdout` for writing output.
|
||||
If you need to use different streams, for instance `process.stderr`, you can set these with the `stdin` and `stdout` properties.
|
||||
|
||||
|
||||

|
||||
|
||||
@@ -790,9 +799,10 @@ You can overwrite how choices are being filtered by passing your own suggest fun
|
||||
| limit | `number` | Max number of results to show. Defaults to `10` |
|
||||
| style | `string` | Render style (`default`, `password`, `invisible`, `emoji`). Defaults to `'default'` |
|
||||
| initial | `string \| number` | Default initial value |
|
||||
| clearFirst | `boolean` | The first ESCAPE keypress will clear the input |
|
||||
| fallback | `string` | Fallback message when no match is found. Defaults to `initial` value if provided |
|
||||
| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |
|
||||
| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |
|
||||
| onState | `function` | On state change callback. Function signature is an `object` with three properties: `value`, `aborted` and `exited` |
|
||||
|
||||
Example on what a `suggest` function might look like:
|
||||
```js
|
||||
|
||||
Reference in New Issue
Block a user