Skip to content

Commit 63ac8f2

Browse files
committed
docs!: add missing signal resolver
1 parent 22a0bfa commit 63ac8f2

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

Diff for: README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,9 @@ Library provides helper methods to render terminal related content.
186186
| `createCommandNotFound` | `command, text = 'command not found', name = 'VueCommandNotFound'` | Creates a command not found component |
187187
| `createStdout` | `formatterOrText, name = 'VueCommandStdout'` | Creates a "stdout" component |
188188
| `createQuery` | | Creates a query component |
189-
| `defaultHistoryEventResolver` | `refs, eventProvider` | Returns the default history resolver |
190-
| `defaultParser` | `query` | Returns the default parser |
189+
| `defaultHistoryEventResolver` | `refs, eventProvider` | The default history event resolver |
190+
| `defaultParser` | `query` | The default parser |
191+
| `defaultSignalEventResolver` | `refs, eventProvider` | The default signal event resolver |
191192
| `jsonFormatter` | `value` | See [Formatters](#formatters) |
192193
| `listFormatter` | `...lis` | See [Formatters](#formatters) |
193194
| `newDefaultEventResolver` | | Returns a new default event resolver |

Diff for: src/library.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export const defaultHistoryEventResolver = (refs, { decrementHistory, incrementH
4848
vueCommandRef.addEventListener('keydown', eventResolver)
4949
}
5050

51-
// Sends common signals based on certain keyboard inputs
51+
// Sends common signals based on certain events
5252
export const defaultSignalEventResolver = (_, { sendSignal }) => {
5353
const eventResolver = event => {
5454
switch (event.ctrlKey) {
@@ -75,13 +75,13 @@ export const newDefaultEventResolver = () => [defaultHistoryEventResolver, defau
7575
// soon as the component has been mounted
7676
export const createStdout = (formatterOrText, name = 'VueCommandStdout') => markRaw(defineComponent({
7777
name,
78-
setup () {
78+
setup() {
7979
// This tears down the component automatically
8080
const exit = inject('exit')
8181
onMounted(exit)
8282
},
8383

84-
render () {
84+
render() {
8585
if (isFunction(formatterOrText)) {
8686
// This is automatically called with the bound arguments
8787
return formatterOrText()

0 commit comments

Comments
 (0)