vike/dist/esm/shared/hooks/getHook.d.ts

The Framework *You* Control - Next.js & Nuxt alternative for unprecedented flexibility and dependability.

export { getHookFromPageContext };
export { getHookFromPageConfig };
export { getHookFromPageConfigGlobal };
export { getHookFromPageConfigGlobalCumulative };
export { assertHook };
export { getHook_setIsPrerenderering };
export type { Hook };
export type { HookName };
export type { HookLoc };
export type { HookTimeout };
export type { HooksTimeoutProvidedByUser };
export { getHookTimeoutDefault };
import type { PageConfigUserFriendlyOld } from '../getPageFiles.js';
import type { HookName, HookNamePage, HookNameGlobal } from '../page-configs/Config.js';
import type { PageConfigGlobalRuntime, PageConfigRuntime } from '../page-configs/PageConfig.js';
type Hook = HookLoc & {
    hookFn: HookFn;
    hookTimeout: HookTimeout;
};
type HookLoc = {
    hookName: HookName;
    hookFilePath: string;
};
type HookFn = (arg: object) => unknown;
type HookTimeout = {
    error: number | false;
    warning: number | false;
};
type HooksTimeoutProvidedByUser = false | Partial<Record<HookName, false | Partial<HookTimeout>>>;
declare function getHookFromPageContext(pageContext: PageConfigUserFriendlyOld, hookName: HookName): null | Hook;
declare function getHookFromPageConfig(pageConfig: PageConfigRuntime, hookName: HookNamePage): null | Hook;
declare function getHookFromPageConfigGlobal(pageConfigGlobal: PageConfigGlobalRuntime, hookName: HookNameGlobal): null | Hook;
declare function getHookFromPageConfigGlobalCumulative(pageConfigGlobal: PageConfigGlobalRuntime, hookName: HookNameGlobal): Hook[];
declare function assertHook<TPageContext extends PageConfigUserFriendlyOld, THookName extends PropertyKey & HookName>(pageContext: TPageContext, hookName: THookName): asserts pageContext is TPageContext & {
    exports: Record<THookName, Function | undefined>;
};
declare function getHookTimeoutDefault(hookName: HookName): HookTimeout;
declare function getHook_setIsPrerenderering(): void;