瀏覽代碼

chore(dx): fix defineProps jsdoc + update defineEmits jsdoc example

Evan You 2 年之前
父節點
當前提交
b4ac0e6ac1
共有 1 個文件被更改,包括 4 次插入3 次删除
  1. 4 3
      packages/runtime-core/src/apiSetupHelpers.ts

+ 4 - 3
packages/runtime-core/src/apiSetupHelpers.ts

@@ -66,9 +66,9 @@ const warnRuntimeUsage = (method: string) =>
  *   foo?: string
  *   bar: number
  * }>()
+ * ```
  *
  * @see {@link https://vuejs.org/api/sfc-script-setup.html#defineprops-defineemits}
- * ```
  *
  * This is only usable inside `<script setup>`, is compiled away in the
  * output and should **not** be actually called at runtime.
@@ -116,8 +116,9 @@ type BooleanKey<T, K extends keyof T = keyof T> = K extends any
  * Example type-based declaration:
  * ```ts
  * const emit = defineEmits<{
- *   (event: 'change'): void
- *   (event: 'update', id: number): void
+ *   // <eventName>: <expected arguments>
+ *   change: []
+ *   update: [value: string] // named tuple syntax
  * }>()
  *
  * emit('change')