@vue/runtime-core 3.2.24 → 3.2.28

package/dist/runtime-core.d.ts

@@ -1,21 +1,28 @@
 import { camelize } from '@vue/shared';
 import { capitalize } from '@vue/shared';
 import { ComponentPropsOptions as ComponentPropsOptions_2 } from '@vue/runtime-core';
-import { computed } from '@vue/reactivity';
+import { computed as computed_2 } from '@vue/reactivity';
 import { ComputedGetter } from '@vue/reactivity';
 import { ComputedRef } from '@vue/reactivity';
+import { ComputedSetter } from '@vue/reactivity';
 import { customRef } from '@vue/reactivity';
+import { CustomRefFactory } from '@vue/reactivity';
 import { DebuggerEvent } from '@vue/reactivity';
+import { DebuggerEventExtraInfo } from '@vue/reactivity';
 import { DebuggerOptions } from '@vue/reactivity';
 import { DeepReadonly } from '@vue/reactivity';
 import { effect } from '@vue/reactivity';
+import { EffectScheduler } from '@vue/reactivity';
 import { EffectScope } from '@vue/reactivity';
 import { effectScope } from '@vue/reactivity';
 import { getCurrentScope } from '@vue/reactivity';
+import { IfAny } from '@vue/shared';
 import { isProxy } from '@vue/reactivity';
 import { isReactive } from '@vue/reactivity';
 import { isReadonly } from '@vue/reactivity';
 import { isRef } from '@vue/reactivity';
+import { isShallow } from '@vue/reactivity';
+import { LooseRequired } from '@vue/shared';
 import { markRaw } from '@vue/reactivity';
 import { normalizeClass } from '@vue/shared';
 import { normalizeProps } from '@vue/shared';
@@ -25,6 +32,7 @@ import { proxyRefs } from '@vue/reactivity';
 import { reactive } from '@vue/reactivity';
 import { ReactiveEffect } from '@vue/reactivity';
 import { ReactiveEffectOptions } from '@vue/reactivity';
+import { ReactiveEffectRunner } from '@vue/reactivity';
 import { ReactiveFlags } from '@vue/reactivity';
 import { readonly } from '@vue/reactivity';
 import { Ref } from '@vue/reactivity';
@@ -32,6 +40,7 @@ import { ref } from '@vue/reactivity';
 import { ShallowReactive } from '@vue/reactivity';
 import { shallowReactive } from '@vue/reactivity';
 import { shallowReadonly } from '@vue/reactivity';
+import { ShallowRef } from '@vue/reactivity';
 import { shallowRef } from '@vue/reactivity';
 import { ShallowUnwrapRef } from '@vue/reactivity';
 import { ShapeFlags } from '@vue/shared';
@@ -47,6 +56,7 @@ import { toRefs } from '@vue/reactivity';
 import { TrackOpTypes } from '@vue/reactivity';
 import { TriggerOpTypes } from '@vue/reactivity';
 import { triggerRef } from '@vue/reactivity';
+import { UnionToIntersection } from '@vue/shared';
 import { unref } from '@vue/reactivity';
 import { UnwrapNestedRefs } from '@vue/reactivity';
 import { UnwrapRef } from '@vue/reactivity';
@@ -95,7 +105,7 @@ export declare interface AppConfig {
     errorHandler?: (err: unknown, instance: ComponentPublicInstance | null, info: string) => void;
     warnHandler?: (msg: string, instance: ComponentPublicInstance | null, trace: string) => void;
     /**
-     * Options to pass to @vue/compiler-dom.
+     * Options to pass to `@vue/compiler-dom`.
      * Only supported in runtime compiler build.
      */
     compilerOptions: RuntimeCompilerOptions;
@@ -224,7 +234,7 @@ export declare type CompatVue = Pick<App, 'version' | 'component' | 'directive'>
     directive(name: string, directive: Directive): CompatVue;
     compile(template: string): RenderFunction;
     /**
-     * @deprecated
+     * @deprecated Vue 3 no longer supports extending constructors.
      */
     extend: (options?: ComponentOptions) => CompatVue;
     /**
@@ -334,6 +344,10 @@ export declare interface ComponentInternalInstance {
      * Root vnode of this component's own vdom tree
      */
     subTree: VNode;
+    /**
+     * Render effect instance
+     */
+    effect: ReactiveEffect;
     /**
      * Bound effect runner to be passed to schedulers
      */
@@ -489,12 +503,16 @@ declare type ComponentWatchOptionItem = WatchOptionItem | WatchOptionItem[];
 
 declare type ComponentWatchOptions = Record<string, ComponentWatchOptionItem>;
 
-export { computed }
+export declare const computed: typeof computed_2;
+
+export { ComputedGetter }
 
 export declare type ComputedOptions = Record<string, ComputedGetter<any> | WritableComputedOptions<any>>;
 
 export { ComputedRef }
 
+export { ComputedSetter }
+
 /**
  * Concrete component type matches its actual value: it's either an options
  * object, or a function. Use this where the code expects to work with actual
@@ -594,10 +612,14 @@ declare function _createVNode(type: VNodeTypes | ClassComponent | typeof NULL_DY
 
 export { customRef }
 
+export { CustomRefFactory }
+
 declare type Data = Record<string, unknown>;
 
 export { DebuggerEvent }
 
+export { DebuggerEventExtraInfo }
+
 declare type DebuggerHook = (e: DebuggerEvent) => void;
 
 export { DebuggerOptions }
@@ -667,7 +689,7 @@ export declare function defineEmits<TypeEmit>(): TypeEmit;
  * instance properties when it is accessed by a parent component via template
  * refs.
  *
- * `<script setup>` components are closed by default - i.e. varaibles inside
+ * `<script setup>` components are closed by default - i.e. variables inside
  * the `<script setup>` scope is not exposed to parent unless explicitly exposed
  * via `defineExpose`.
  *
@@ -745,7 +767,6 @@ export declare const enum DeprecationTypes {
     OPTIONS_DESTROYED = "OPTIONS_DESTROYED",
     WATCH_ARRAY = "WATCH_ARRAY",
     PROPS_DEFAULT_THIS = "PROPS_DEFAULT_THIS",
-    V_FOR_REF = "V_FOR_REF",
     V_ON_KEYCODE_MODIFIER = "V_ON_KEYCODE_MODIFIER",
     CUSTOM_DIR = "CUSTOM_DIR",
     ATTR_FALSE_VALUE = "ATTR_FALSE_VALUE",
@@ -790,6 +811,8 @@ declare type DirectiveModifiers = Record<string, boolean>;
 
 export { effect }
 
+export { EffectScheduler }
+
 export { EffectScope }
 
 export { effectScope }
@@ -853,15 +876,10 @@ any, // Mixin
 any, // Extends
 any> ? unknown extends P ? {} : P : {};
 
-export declare type ExtractPropTypes<O> = O extends object ? {
-    [K in keyof O]?: unknown;
-} & // This is needed to keep the relation between the option prop and the props, allowing to use ctrl+click to navigate to the prop options. see: #3656
-    {
-    [K in RequiredKeys<O>]: InferPropType<O[K]>;
+export declare type ExtractPropTypes<O> = {
+    [K in keyof Pick<O, RequiredKeys<O>>]: InferPropType<O[K]>;
 } & {
-    [K in OptionalKeys<O>]?: InferPropType<O[K]>;
-} : {
-    [K in string]: any;
+    [K in keyof Pick<O, OptionalKeys<O>>]?: InferPropType<O[K]>;
 };
 
 export declare const Fragment: {
@@ -946,8 +964,6 @@ export declare interface HydrationRenderer extends Renderer<Element | ShadowRoot
     hydrate: RootHydrateFunction;
 }
 
-declare type IfAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
-
 declare type InferDefault<P, T> = T extends null | number | string | boolean | symbol | Function ? T : (props: P) => T;
 
 declare type InferDefaults<T> = {
@@ -985,8 +1001,6 @@ declare type InternalSlots = {
 
 declare type IntersectionMixin<T> = IsDefaultMixinComponent<T> extends true ? OptionTypesType<{}, {}, {}, {}, {}> : UnionToIntersection<ExtractMixin<T>>;
 
-declare type InvalidateCbRegistrator = (cb: () => void) => void;
-
 declare function isCompatEnabled(key: DeprecationTypes, instance: ComponentInternalInstance | null, enableForBuiltIn?: boolean): boolean;
 
 declare type IsDefaultMixinComponent<T> = T extends ComponentOptionsMixin ? ComponentOptionsMixin extends T ? true : false : false;
@@ -1003,6 +1017,8 @@ export { isRef }
 
 export declare const isRuntimeOnly: () => boolean;
 
+export { isShallow }
+
 export declare function isVNode(value: any): value is VNode;
 
 export declare const KeepAlive: {
@@ -1025,7 +1041,7 @@ export declare type LegacyConfig = {
     silent?: boolean;
     /**
      * @deprecated use __VUE_PROD_DEVTOOLS__ compile-time feature flag instead
-     * https://github.com/vuejs/vue-next/tree/master/packages/vue#bundler-build-feature-flags
+     * https://github.com/vuejs/core/tree/main/packages/vue#bundler-build-feature-flags
      */
     devtools?: boolean;
     /**
@@ -1124,17 +1140,13 @@ declare const enum LifecycleHooks {
     SERVER_PREFETCH = "sp"
 }
 
-declare type LooseRequired<T> = {
-    [P in string & keyof T]: T[P];
-};
-
 declare type MapSources<T, Immediate> = {
     [K in keyof T]: T[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : T[K] extends object ? Immediate extends true ? T[K] | undefined : T[K] : never;
 };
 
 export { markRaw }
 
-declare type MatchPattern = string | RegExp | string[] | RegExp[];
+declare type MatchPattern = string | RegExp | (string | RegExp)[];
 
 declare type MergedComponentOptions = ComponentOptions & MergedComponentOptionsOverride;
 
@@ -1244,6 +1256,8 @@ export declare const onBeforeUnmount: (hook: () => any, target?: ComponentIntern
 
 export declare const onBeforeUpdate: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
 
+declare type OnCleanup = (cleanupFn: () => void) => void;
+
 export declare function onDeactivated(hook: Function, target?: ComponentInternalInstance | null): void;
 
 export declare function onErrorCaptured<TError = Error>(hook: ErrorCapturedHook<TError>, target?: ComponentInternalInstance | null): void;
@@ -1381,6 +1395,10 @@ export { ReactiveEffect }
 
 export { ReactiveEffectOptions }
 
+export { ReactiveEffectRunner }
+
+export { ReactiveFlags }
+
 export { readonly }
 
 export { Ref }
@@ -1440,7 +1458,7 @@ export declare interface RendererOptions<HostNode = RendererNode, HostElement =
     querySelector?(selector: string): HostElement | null;
     setScopeId?(el: HostElement, id: string): void;
     cloneNode?(node: HostNode): HostNode;
-    insertStaticContent?(content: string, parent: HostElement, anchor: HostNode | null, isSVG: boolean): [HostNode, HostNode];
+    insertStaticContent?(content: string, parent: HostElement, anchor: HostNode | null, isSVG: boolean, start?: HostNode | null, end?: HostNode | null): [HostNode, HostNode];
 }
 
 export declare type RenderFunction = () => VNodeChild;
@@ -1607,6 +1625,8 @@ export { shallowReactive }
 
 export { shallowReadonly }
 
+export { ShallowRef }
+
 export { shallowRef }
 
 export { ShallowUnwrapRef }
@@ -1763,8 +1783,6 @@ export { TriggerOpTypes }
 
 export { triggerRef }
 
-declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-
 declare type UnmountChildrenFn = (children: VNode[], parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, doRemove?: boolean, optimized?: boolean, start?: number) => void;
 
 declare type UnmountFn = (vnode: VNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, doRemove?: boolean, optimized?: boolean) => void;
@@ -1773,6 +1791,8 @@ export { unref }
 
 declare type UnwrapMixinsType<T, Type extends OptionTypesKeys> = T extends OptionTypesType ? T[Type] : never;
 
+export { UnwrapNestedRefs }
+
 export { UnwrapRef }
 
 export declare function useAttrs(): SetupContext['attrs'];
@@ -1839,12 +1859,15 @@ declare type VNodeNormalizedRef = VNodeNormalizedRefAtom | VNodeNormalizedRefAto
 declare type VNodeNormalizedRefAtom = {
     i: ComponentInternalInstance;
     r: VNodeRef;
+    k?: string;
     f?: boolean;
 };
 
 export declare type VNodeProps = {
     key?: string | number | symbol;
     ref?: VNodeRef;
+    ref_for?: boolean;
+    ref_key?: string;
     onVnodeBeforeMount?: VNodeMountHook | VNodeMountHook[];
     onVnodeMounted?: VNodeMountHook | VNodeMountHook[];
     onVnodeBeforeUpdate?: VNodeUpdateHook | VNodeUpdateHook[];
@@ -1871,9 +1894,9 @@ export declare function watch<T, Immediate extends Readonly<boolean> = false>(so
 
 export declare function watch<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchOptions<Immediate>): WatchStopHandle;
 
-export declare type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV, onInvalidate: InvalidateCbRegistrator) => any;
+export declare type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV, onCleanup: OnCleanup) => any;
 
-export declare type WatchEffect = (onInvalidate: InvalidateCbRegistrator) => void;
+export declare type WatchEffect = (onCleanup: OnCleanup) => void;
 
 export declare function watchEffect(effect: WatchEffect, options?: WatchOptionsBase): WatchStopHandle;