@@ -59,6 +59,8 @@ const warnRuntimeUsage = (method: string) =>
5959 * foo?: string
6060 * bar: number
6161 * }>()
62+ *
63+ * @see {@link https://vuejs.org/api/sfc-script-setup.html#defineprops-defineemits }
6264 * ```
6365 *
6466 * This is only usable inside `<script setup>`, is compiled away in the
@@ -118,6 +120,8 @@ type BooleanKey<T, K extends keyof T = keyof T> = K extends any
118120 *
119121 * This is only usable inside `<script setup>`, is compiled away in the
120122 * output and should **not** be actually called at runtime.
123+ *
124+ * @see {@link https://vuejs.org/api/sfc-script-setup.html#defineprops-defineemits }
121125 */
122126// overload 1: runtime emits w/ array
123127export function defineEmits < EE extends string = string > (
@@ -156,6 +160,8 @@ type ShortEmits<T extends Record<string, any>> = UnionToIntersection<
156160 *
157161 * This is only usable inside `<script setup>`, is compiled away in the
158162 * output and should **not** be actually called at runtime.
163+ *
164+ * @see {@link https://vuejs.org/api/sfc-script-setup.html#defineexpose }
159165 */
160166export function defineExpose <
161167 Exposed extends Record < string , any > = Record < string , any >
@@ -165,6 +171,13 @@ export function defineExpose<
165171 }
166172}
167173
174+ /**
175+ * Vue `<script setup>` compiler macro for declaring a component's additional
176+ * options. This should be used only for options that cannot be expressed via
177+ * Composition API - e.g. `inhertiAttrs`.
178+ *
179+ * @see {@link https://vuejs.org/api/sfc-script-setup.html#defineoptions }
180+ */
168181export function defineOptions <
169182 RawBindings = { } ,
170183 D = { } ,
@@ -232,6 +245,8 @@ type PropsWithDefaults<Base, Defaults> = Base & {
232245 *
233246 * This is only usable inside `<script setup>`, is compiled away in the output
234247 * and should **not** be actually called at runtime.
248+ *
249+ * @see {@link https://vuejs.org/guide/typescript/composition-api.html#typing-component-props }
235250 */
236251export function withDefaults < Props , Defaults extends InferDefaults < Props > > (
237252 props : Props ,
0 commit comments