@quasar/app-vite/types/ui-wrappers.d.ts

Quasar Framework App CLI with Vite

/*******************************************************
 * Warning!
 *
 * LEGACY way of doing it. Use the app-wrappers instead.
 *******************************************************/

// These wrappers are into `app`, instead of `ui`, because they are only relevant to people
//  using a Quasar CLI project: TS devs using `quasar` package via Vue CLI plugin don't have
//  boot files or `quasar.config` file where to use them.
// They are placed in a standalone file into `ui` because they must be reachable as `quasar/wrappers`.
// Not being exposed from `quasar`, they won't trigger the package side-effects when required into
//  a file evaluated by Node (in `quasar.config` file, `configure` would be imported as
//  `import { configure } from 'quasar'`).
// This is a precaution measure to avoid future hard-to-backtrack bugs.

declare module "quasar/wrappers" {
  import type {
    BootCallback,
    ConfigureCallback,
    PrefetchCallback,
    RouteCallback,
    StoreCallback,
    SsrMiddlewareCallback,
    SsrCreateCallback,
    SsrListenCallback,
    SsrCloseCallback,
    SsrServeStaticContentCallback,
    SsrRenderPreloadTagCallback
  } from "@quasar/app-vite";

  /** Some arguments are available only if you enable the related mode: `store` when using the Store, `ssrContext` when using SSR, etc */
  function boot(callback: BootCallback): BootCallback;

  function configure(callback: ConfigureCallback): ConfigureCallback;

  function preFetch(callback: PrefetchCallback): PrefetchCallback;

  function route(callback: RouteCallback): RouteCallback;

  function store(callback: StoreCallback): StoreCallback;

  function ssrMiddleware(
    callback: SsrMiddlewareCallback
  ): SsrMiddlewareCallback;

  function ssrCreate(callback: SsrCreateCallback): SsrCreateCallback;

  function ssrListen(callback: SsrListenCallback): SsrListenCallback;

  function ssrClose(callback: SsrCloseCallback): SsrCloseCallback;

  function ssrServeStaticContent(
    callback: SsrServeStaticContentCallback
  ): SsrServeStaticContentCallback;

  function ssrRenderPreloadTag(
    callback: SsrRenderPreloadTagCallback
  ): SsrRenderPreloadTagCallback;
}