vike
Version:
The Framework *You* Control - Next.js & Nuxt alternative for unprecedented flexibility and dependability.
297 lines (296 loc) • 12.3 kB
TypeScript
export { renderPageAlreadyRouted };
export { prerenderPage };
export type { PageContextAfterRender };
import { type PageContextUrlInternal } from '../../../shared/getPageContextUrlComputed.js';
import { HttpResponse } from './createHttpResponse.js';
import { PageContext_loadPageConfigsLazyServerSide, type PageConfigsLazy } from './loadPageConfigsLazyServerSide.js';
import type { PageContextCreated } from './createPageContextServerSide.js';
type PageContextAfterRender = {
httpResponse: HttpResponse;
errorWhileRendering: null | Error;
};
declare function renderPageAlreadyRouted<PageContext extends {
pageId: string;
_pageContextAlreadyProvidedByOnPrerenderHook?: true;
is404: null | boolean;
routeParams: Record<string, string>;
errorWhileRendering: null | Error;
_httpRequestId: number;
} & PageContextCreated & PageContextUrlInternal & PageContext_loadPageConfigsLazyServerSide>(pageContext: PageContext): Promise<PageContext & PageContextAfterRender>;
declare function prerenderPage(pageContext: PageContextCreated & PageConfigsLazy & {
routeParams: Record<string, string>;
pageId: string;
_urlRewrite: null;
_httpRequestId: number | null;
_usesClientRouter: boolean;
_pageContextAlreadyProvidedByOnPrerenderHook?: true;
is404: boolean;
}): Promise<{
documentHtml: string;
pageContextSerialized: null;
pageContext: {
_isOriginalObject: true;
isPageContext: true;
} & {
isClientSide: false;
isPrerendering: boolean;
} & Pick<import("../../../types/PageContext.js").PageContextInternalServer, "urlOriginal" | "headersOriginal"> & {
url?: string;
headers?: Record<string, string>;
} & {
_globalContext: {
isGlobalContext: true;
_isOriginalObject: true;
_virtualFileExports: unknown;
_pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
_pageConfigs: import("../../../types/PageConfig.js").PageConfigRuntime[];
_pageConfigGlobal: import("../../../types/PageConfig.js").PageConfigGlobalRuntime;
_allPageIds: string[];
_vikeConfigPublicGlobal: {
config: import("../../../types/index.js").ConfigResolved;
_source: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Source;
_sources: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Sources;
_from: import("../../../shared/page-configs/resolveVikeConfigPublic.js").From;
};
config: import("../../../types/index.js").ConfigResolved;
pages: {
[k: string]: import("../../../shared/page-configs/resolveVikeConfigPublic.js").VikeConfigPublicPageEager;
};
} & ({
_isProduction: false;
_isPrerendering: false;
assetsManifest: null;
_viteDevServer: import("vite").ViteDevServer;
viteConfig: import("vite").ResolvedConfig;
viteConfigRuntime: {
root: string;
build: {
outDir: string;
};
_baseViteOriginal: string;
vitePluginServerEntry: {
inject: boolean | undefined;
};
};
baseServer: string;
baseAssets: string;
isClientSide: false;
_pageRoutes: import("../../../__internal/index.js").PageRoutes;
_onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
} | {
_isPrerendering: true;
viteConfig: import("vite").ResolvedConfig;
_isProduction: true;
assetsManifest: import("../../../types/ViteManifest.js").ViteManifest;
_viteDevServer: null;
viteConfigRuntime: {
root: string;
build: {
outDir: string;
};
_baseViteOriginal: string;
vitePluginServerEntry: {
inject: boolean | undefined;
};
};
_usesClientRouter: boolean;
baseServer: string;
baseAssets: string;
isClientSide: false;
_pageRoutes: import("../../../__internal/index.js").PageRoutes;
_onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
} | {
_isPrerendering: false;
viteConfig: null;
_isProduction: true;
assetsManifest: import("../../../types/ViteManifest.js").ViteManifest;
_viteDevServer: null;
viteConfigRuntime: {
root: string;
build: {
outDir: string;
};
_baseViteOriginal: string;
vitePluginServerEntry: {
inject: boolean | undefined;
};
};
_usesClientRouter: boolean;
baseServer: string;
baseAssets: string;
isClientSide: false;
_pageRoutes: import("../../../__internal/index.js").PageRoutes;
_onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
});
_pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
_baseServer: string;
_baseAssets: string;
_pageContextInit: import("../renderPage.js").PageContextInit;
_urlRewrite: null;
_urlHandler: ((url: string) => string) | null;
isClientSideNavigation: boolean;
} & {
config: import("../../../types/index.js").ConfigResolved;
_source: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Source;
_sources: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Sources;
_from: import("../../../shared/page-configs/resolveVikeConfigPublic.js").From;
} & {
urlParsed: import("../utils.js").UrlPublic;
urlPathname: string;
url: string;
} & {
headers: Record<string, string> | null;
} & import("../../../shared/getPageFiles.js").VikeConfigPublicPageLazy & {
Page: unknown;
_isHtmlOnly: boolean;
_passToClient: string[];
_pageFilePathsLoaded: string[];
} & {
__getPageAssets: () => Promise<import("./getPageAssets.js").PageAsset[]>;
} & {
routeParams: Record<string, string>;
pageId: string;
_urlRewrite: null;
_httpRequestId: number | null;
_usesClientRouter: boolean;
_pageContextAlreadyProvidedByOnPrerenderHook?: true;
is404: boolean;
} & {
isClientSideNavigation: boolean;
_urlHandler: null;
};
} | {
documentHtml: string;
pageContextSerialized: string;
pageContext: {
_isOriginalObject: true;
isPageContext: true;
} & {
isClientSide: false;
isPrerendering: boolean;
} & Pick<import("../../../types/PageContext.js").PageContextInternalServer, "urlOriginal" | "headersOriginal"> & {
url?: string;
headers?: Record<string, string>;
} & {
_globalContext: {
isGlobalContext: true;
_isOriginalObject: true;
_virtualFileExports: unknown;
_pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
_pageConfigs: import("../../../types/PageConfig.js").PageConfigRuntime[];
_pageConfigGlobal: import("../../../types/PageConfig.js").PageConfigGlobalRuntime;
_allPageIds: string[];
_vikeConfigPublicGlobal: {
config: import("../../../types/index.js").ConfigResolved;
_source: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Source;
_sources: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Sources;
_from: import("../../../shared/page-configs/resolveVikeConfigPublic.js").From;
};
config: import("../../../types/index.js").ConfigResolved;
pages: {
[k: string]: import("../../../shared/page-configs/resolveVikeConfigPublic.js").VikeConfigPublicPageEager;
};
} & ({
_isProduction: false;
_isPrerendering: false;
assetsManifest: null;
_viteDevServer: import("vite").ViteDevServer;
viteConfig: import("vite").ResolvedConfig;
viteConfigRuntime: {
root: string;
build: {
outDir: string;
};
_baseViteOriginal: string;
vitePluginServerEntry: {
inject: boolean | undefined;
};
};
baseServer: string;
baseAssets: string;
isClientSide: false;
_pageRoutes: import("../../../__internal/index.js").PageRoutes;
_onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
} | {
_isPrerendering: true;
viteConfig: import("vite").ResolvedConfig;
_isProduction: true;
assetsManifest: import("../../../types/ViteManifest.js").ViteManifest;
_viteDevServer: null;
viteConfigRuntime: {
root: string;
build: {
outDir: string;
};
_baseViteOriginal: string;
vitePluginServerEntry: {
inject: boolean | undefined;
};
};
_usesClientRouter: boolean;
baseServer: string;
baseAssets: string;
isClientSide: false;
_pageRoutes: import("../../../__internal/index.js").PageRoutes;
_onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
} | {
_isPrerendering: false;
viteConfig: null;
_isProduction: true;
assetsManifest: import("../../../types/ViteManifest.js").ViteManifest;
_viteDevServer: null;
viteConfigRuntime: {
root: string;
build: {
outDir: string;
};
_baseViteOriginal: string;
vitePluginServerEntry: {
inject: boolean | undefined;
};
};
_usesClientRouter: boolean;
baseServer: string;
baseAssets: string;
isClientSide: false;
_pageRoutes: import("../../../__internal/index.js").PageRoutes;
_onBeforeRouteHook: import("../../../shared/hooks/getHook.js").Hook | null;
});
_pageFilesAll: import("../../../shared/getPageFiles.js").PageFile[];
_baseServer: string;
_baseAssets: string;
_pageContextInit: import("../renderPage.js").PageContextInit;
_urlRewrite: null;
_urlHandler: ((url: string) => string) | null;
isClientSideNavigation: boolean;
} & {
config: import("../../../types/index.js").ConfigResolved;
_source: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Source;
_sources: import("../../../shared/page-configs/resolveVikeConfigPublic.js").Sources;
_from: import("../../../shared/page-configs/resolveVikeConfigPublic.js").From;
} & {
urlParsed: import("../utils.js").UrlPublic;
urlPathname: string;
url: string;
} & {
headers: Record<string, string> | null;
} & import("../../../shared/getPageFiles.js").VikeConfigPublicPageLazy & {
Page: unknown;
_isHtmlOnly: boolean;
_passToClient: string[];
_pageFilePathsLoaded: string[];
} & {
__getPageAssets: () => Promise<import("./getPageAssets.js").PageAsset[]>;
} & {
routeParams: Record<string, string>;
pageId: string;
_urlRewrite: null;
_httpRequestId: number | null;
_usesClientRouter: boolean;
_pageContextAlreadyProvidedByOnPrerenderHook?: true;
is404: boolean;
} & {
isClientSideNavigation: boolean;
_urlHandler: null;
};
}>;