@vue/runtime-core 3.5.0-alpha.3 → 3.5.0-alpha.5

package/dist/runtime-core.d.ts

@@ -1119,7 +1119,7 @@ declare enum TeleportMoveTypes {
     REORDER = 2
 }
 declare function moveTeleport(vnode: VNode, container: RendererElement, parentAnchor: RendererNode | null, { o: { insert }, m: move }: RendererInternals, moveType?: TeleportMoveTypes): void;
-declare function hydrateTeleport(node: Node, vnode: TeleportVNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, slotScopeIds: string[] | null, optimized: boolean, { o: { nextSibling, parentNode, querySelector }, }: RendererInternals<Node, Element>, hydrateChildren: (node: Node | null, vnode: VNode, container: Element, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, slotScopeIds: string[] | null, optimized: boolean) => Node | null): Node | null;
+declare function hydrateTeleport(node: Node, vnode: TeleportVNode, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, slotScopeIds: string[] | null, optimized: boolean, { o: { nextSibling, parentNode, querySelector, insert, createText }, }: RendererInternals<Node, Element>, hydrateChildren: (node: Node | null, vnode: VNode, container: Element, parentComponent: ComponentInternalInstance | null, parentSuspense: SuspenseBoundary | null, slotScopeIds: string[] | null, optimized: boolean) => Node | null): Node | null;
 export declare const Teleport: {
     new (): {
         $props: VNodeProps & TeleportProps;
@@ -1461,7 +1461,7 @@ export declare function registerRuntimeCompiler(_compile: any): void;
 export declare const isRuntimeOnly: () => boolean;
 
 export type WatchEffect = (onCleanup: OnCleanup) => void;
-export type WatchSource<T = any> = Ref<T> | ComputedRef<T> | (() => T);
+export type WatchSource<T = any> = Ref<T, any> | ComputedRef<T> | (() => T);
 export type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV, onCleanup: OnCleanup) => any;
 type MaybeUndefined<T, I> = I extends true ? T | undefined : T;
 type MapSources<T, Immediate> = {
@@ -1486,6 +1486,22 @@ export declare function watch<T extends Readonly<MultiWatchSources>, Immediate e
 export declare function watch<T extends MultiWatchSources, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
 export declare function watch<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, MaybeUndefined<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
 
+/**
+ * A lazy hydration strategy for async components.
+ * @param hydrate - call this to perform the actual hydration.
+ * @param forEachElement - iterate through the root elements of the component's
+ *                         non-hydrated DOM, accounting for possible fragments.
+ * @returns a teardown function to be called if the async component is unmounted
+ *          before it is hydrated. This can be used to e.g. remove DOM event
+ *          listeners.
+ */
+export type HydrationStrategy = (hydrate: () => void, forEachElement: (cb: (el: Element) => any) => void) => (() => void) | void;
+export type HydrationStrategyFactory<Options = any> = (options?: Options) => HydrationStrategy;
+export declare const hydrateOnIdle: HydrationStrategyFactory;
+export declare const hydrateOnVisible: HydrationStrategyFactory<string | number>;
+export declare const hydrateOnMediaQuery: HydrationStrategyFactory<string>;
+export declare const hydrateOnInteraction: HydrationStrategyFactory<string | string[]>;
+
 type AsyncComponentResolveResult<T = Component> = T | {
     default: T;
 };
@@ -1497,6 +1513,7 @@ export interface AsyncComponentOptions<T = any> {
     delay?: number;
     timeout?: number;
     suspensible?: boolean;
+    hydrate?: HydrationStrategy;
     onError?: (error: Error, retry: () => void, fail: () => void, attempts: number) => any;
 }
 /*! #__NO_SIDE_EFFECTS__ */