Skip to content

Commit

Permalink
docs(prompt): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
c4spar committed Jan 7, 2021
1 parent a637b54 commit 5d060b0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions prompt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,6 @@ An prompt object has following options and all type specific options. See the li
| ----- | :---: | :---: | ----------- |
| name | `string` | Yes | The response will be saved under this key/property in the returned response object. |
| type | `string` | Yes | Defines the type of prompt to display. See the list of [prompt types](#-types) for valid values. |
| cbreak | `boolean` | No | cbreak mode enables pass-through of os signals to deno, allowing you to register your own signal handler (see [OS Signals](#os-singals)). **This is an unstable feature and requires Deno => 1.6!** |
| before | `(result, next) => Promise<void>` | No | `next()`execute's the next prompt in the list (for the before callback it's the current prompt). To change the index to a specific prompt you can pass the name or index of the prompt to the `next()` method. To skip this prompt you can pass `true` to the `next()` method. If `next()` isn't called all other prompts will be skipped. |
| after | `(result, next) => Promise<void>` | No | Same as `before` but will be executed *after* the prompt. |

Expand All @@ -305,6 +304,7 @@ The prompt method has also following global options.
| ----- | :---: | :---: | ----------- |
| before | `(result, next) => Promise<void>` | No | Same as above but will be executed before each prompt. |
| after | `(result, next) => Promise<void>` | No | Same as above but will be executed after each prompt. |
| cbreak | `boolean` | No | cbreak mode enables pass-through of os signals to deno, allowing you to register your own signal handler (see [OS Signals](#os-signals)). **This is an unstable feature and requires Deno => 1.6!** |

### Prompt.prompt(options)

Expand Down Expand Up @@ -334,7 +334,7 @@ All prompts have the following base options:
| hint | `string` | No | Hint to display to the user. |
| pointer | `string` | No | Change the pointer icon. |
| indent | `string` | No | Prompt indentation. Defaults to `' '` |
| cbreak | `boolean` | No | cbreak mode enables pass-through of os signals to deno, allowing you to register your own signal handler (see [OS Signals](#os-singals)). **This is an unstable feature and requires Deno => 1.6!** |
| cbreak | `boolean` | No | cbreak mode enables pass-through of os signals to deno, allowing you to register your own signal handler (see [OS Signals](#os-signals)). **This is an unstable feature and requires Deno => 1.6!** |

***

Expand Down

0 comments on commit 5d060b0

Please sign in to comment.