nuxt/dist/app/components/utils.d.ts

Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js.

import { NuxtApp } from "../nuxt.js";
import { RendererNode, TransitionProps, VNode } from "vue";
import { RouteLocationNormalized } from "vue-router";
//#region src/app/components/utils.d.ts
/**
 * Internal utility
 * @private
 */
export declare const _wrapInTransition: (props: any, children: any) => {
  default: () => VNode | undefined;
};
/**
 * Utility used within router guards
 * return true if the route has been changed with a page change during navigation
 */
export declare function isChangingPage(to: RouteLocationNormalized, from: RouteLocationNormalized): boolean;
/**
 * Detect a vapor slot function passed into a vdom component via interop.
 *
 * Vapor slots carry Vue's `rawVaporSlotKey` on the slot function itself, so
 * they can be recognised without invoking the slot. Calling a vapor slot to
 * inspect the shape of its returned VNodes is not a safe dry run (its content is
 * not expressed as a VNode tree), so callers use this to skip VNode-shape
 * heuristics rather than silently make a wrong decision.
 */
export declare function isVaporSlot(slot: ((...args: any[]) => any) | undefined | null): boolean;
/** Return `tag` if it is a safe HTML tag name, otherwise `fallback`. */
export declare function sanitizeTag(tag: string | undefined, fallback: string): string;
export type SSRBuffer = SSRBufferItem[] & {
  hasAsync?: boolean;
};
export type SSRBufferItem = string | SSRBuffer | Promise<SSRBuffer>;
/**
 * create buffer retrieved from @vue/server-renderer
 * @see https://github.com/vuejs/core/blob/9617dd4b2abc07a5dc40de6e5b759e851b4d0da1/packages/server-renderer/src/render.ts#L57
 * @private
 */
export declare function createBuffer(): {
  getBuffer: () => SSRBuffer;
  push: (item: SSRBufferItem) => void;
};
/**
 * helper for NuxtIsland to generate a correct array for scoped data
 */
export declare function vforToArray(source: any): any[];
/**
 * Retrieve the HTML content from an element
 * Handles `<!--[-->` Fragment elements
 * @param element the element to retrieve the HTML
 * @param withoutSlots purge all slots from the HTML string retrieved
 * @returns {string[]|undefined} An array of string which represent the content of each element. Use `.join('')` to retrieve a component vnode.el HTML
 */
export declare function getFragmentHTML(element: RendererNode | null, withoutSlots?: boolean): string[] | undefined;
/**
 * Return a static vnode from an element
 * Default to a div if the element is not found and if a fallback is not provided
 * @param el renderer node retrieved from the component internal instance
 * @param staticNodeFallback fallback string to use if the element is not found. Must be a valid HTML string
 */
export declare function elToStaticVNode(el: RendererNode | null, staticNodeFallback?: string): VNode;
export declare function isStartFragment(element: RendererNode): boolean;
export declare function isEndFragment(element: RendererNode): boolean;
export declare function toArray<T>(value: T | T[]): T[];
/**
 * Internal utility
 * @private
 */
export declare function _mergeTransitionProps(routeProps: TransitionProps[]): TransitionProps;
export declare function _startTransition(nuxtApp: NuxtApp): void;
export declare function _finishTransition(nuxtApp: NuxtApp): void;
//#endregion