34 lines
1.7 KiB
TypeScript
34 lines
1.7 KiB
TypeScript
import type { H3Event } from 'h3';
|
|
import type { H3Event$Fetch } from 'nitropack';
|
|
import type { NuxtApp } from '../nuxt.js';
|
|
/** @since 3.0.0 */
|
|
export declare function useRequestEvent(nuxtApp?: NuxtApp): H3Event<import("h3").EventHandlerRequest> | undefined;
|
|
/** @since 3.0.0 */
|
|
export declare function useRequestHeaders<K extends string = string>(include: K[]): {
|
|
[key in Lowercase<K>]?: string;
|
|
};
|
|
export declare function useRequestHeaders(): Readonly<Record<string, string>>;
|
|
/** @since 3.9.0 */
|
|
export declare function useRequestHeader(header: string): string | undefined;
|
|
/** @since 3.2.0 */
|
|
export declare function useRequestFetch(): H3Event$Fetch | typeof global.$fetch;
|
|
/** @since 3.0.0 */
|
|
export declare function setResponseStatus(event: H3Event, code?: number, message?: string): void;
|
|
/** @deprecated Pass `event` as first option. */
|
|
export declare function setResponseStatus(code: number, message?: string): void;
|
|
/** @since 3.14.0 */
|
|
export declare function useResponseHeader(header: string): import("vue").Ref<any, any>;
|
|
/** @since 3.8.0 */
|
|
export declare function prerenderRoutes(path: string | string[]): void;
|
|
/**
|
|
* `onPrehydrate` is a composable lifecycle hook that allows you to run a callback on the client immediately before
|
|
* Nuxt hydrates the page. This is an advanced feature.
|
|
*
|
|
* The callback will be stringified and inlined in the HTML so it should not have any external
|
|
* dependencies (such as auto-imports) or refer to variables defined outside the callback.
|
|
*
|
|
* The callback will run before Nuxt runtime initializes so it should not rely on the Nuxt or Vue context.
|
|
* @since 3.12.0
|
|
*/
|
|
export declare function onPrehydrate(callback: (el: HTMLElement) => void): void;
|