h3 0.8.6 → 1.0.1

package/dist/index.d.ts

@@ -1,16 +1,15 @@
-import { IncomingMessage, ServerResponse, OutgoingMessage } from 'http';
-export { IncomingMessage as NodeIncomingMessage, ServerResponse as NodeServerResponse } from 'http';
+import { IncomingMessage, ServerResponse, OutgoingMessage } from 'node:http';
+export { IncomingMessage as NodeIncomingMessage, ServerResponse as NodeServerResponse } from 'node:http';
 import { CookieSerializeOptions } from 'cookie-es';
-import { RequestHeaders as RequestHeaders$1 } from 'src/types';
 import * as ufo from 'ufo';
 
-declare type HTTPMethod = 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE';
-declare type Encoding = false | 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'latin1' | 'binary' | 'hex';
+declare type HTTPMethod = "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE";
+declare type Encoding = false | "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex";
 interface H3EventContext extends Record<string, any> {
 }
 declare type EventHandlerResponse<T = any> = T | Promise<T>;
 interface EventHandler<T = any> {
-    '__is_handler__'?: true;
+    "__is_handler__"?: true;
     (event: H3Event): EventHandlerResponse<T>;
 }
 declare type LazyEventHandler = () => EventHandler | Promise<EventHandler>;
@@ -63,12 +62,20 @@ declare class H3Response implements Response {
     text(): Promise<string>;
 }
 
-declare class H3Event implements Pick<FetchEvent, 'respondWith'> {
-    '__is_event__': boolean;
+interface NodeEventContext {
     req: IncomingMessage;
     res: ServerResponse;
+}
+declare class H3Event implements Pick<FetchEvent, "respondWith"> {
+    "__is_event__": boolean;
+    node: NodeEventContext;
     context: H3EventContext;
     constructor(req: IncomingMessage, res: ServerResponse);
+    get path(): string | undefined;
+    /** @deprecated Please use `event.node.res` instead. **/
+    get req(): IncomingMessage;
+    /** @deprecated Please use `event.node.res` instead. **/
+    get res(): ServerResponse<IncomingMessage>;
     respondWith(r: H3Response | PromiseLike<H3Response>): void;
 }
 declare function isEvent(input: any): input is H3Event;
@@ -172,8 +179,6 @@ declare function useBase(base: string, handler: EventHandler): EventHandler;
  * @return {String|Buffer} Encoded raw string or raw Buffer of the body
  */
 declare function readRawBody(event: H3Event, encoding?: Encoding): Encoding extends false ? Buffer : Promise<string | Buffer | undefined>;
-/** @deprecated Use `h3.readRawBody` */
-declare const useRawBody: typeof readRawBody;
 /**
  * Reads request body and try to safely parse using [destr](https://github.com/unjs/destr)
  * @param event {H3Event} H3 event or req passed by h3 handler
@@ -186,8 +191,6 @@ declare const useRawBody: typeof readRawBody;
  * ```
  */
 declare function readBody<T = any>(event: H3Event): Promise<T>;
-/** @deprecated Use `h3.readBody` */
-declare const useBody: typeof readBody;
 
 interface CacheConditions {
     modifiedTime?: string | Date;
@@ -216,8 +219,6 @@ declare const MIMES: {
  * ```
  */
 declare function parseCookies(event: H3Event): Record<string, string>;
-/** @deprecated Use `h3.parseCookies` */
-declare const useCookies: typeof parseCookies;
 /**
  * Get a cookie value by name.
  * @param event {H3Event} H3 event or req passed by h3 handler
@@ -228,8 +229,6 @@ declare const useCookies: typeof parseCookies;
  * ```
  */
 declare function getCookie(event: H3Event, name: string): string | undefined;
-/** @deprecated Use `h3.getCookie` */
-declare const useCookie: typeof getCookie;
 /**
  * Set a cookie value by name.
  * @param event {H3Event} H3 event or res passed by h3 handler
@@ -252,22 +251,19 @@ declare function setCookie(event: H3Event, name: string, value: string, serializ
  */
 declare function deleteCookie(event: H3Event, name: string, serializeOptions?: CookieSerializeOptions): void;
 
-interface SendProxyOptions {
-    headers?: RequestHeaders$1 | HeadersInit;
+interface ProxyOptions {
+    headers?: RequestHeaders | HeadersInit;
     fetchOptions?: RequestInit;
     fetch?: typeof fetch;
     sendStream?: boolean;
 }
-declare function sendProxy(event: H3Event, target: string, opts?: SendProxyOptions): Promise<void>;
+declare function proxyRequest(event: H3Event, target: string, opts?: ProxyOptions): Promise<void>;
+declare function sendProxy(event: H3Event, target: string, opts?: ProxyOptions): Promise<void>;
 
 declare function getQuery(event: H3Event): ufo.QueryObject;
-/** @deprecated Use `h3.getQuery` */
-declare const useQuery: typeof getQuery;
-declare function getRouterParams(event: H3Event): H3Event['context'];
-declare function getRouterParam(event: H3Event, name: string): H3Event['context'][string];
+declare function getRouterParams(event: H3Event): H3Event["context"];
+declare function getRouterParam(event: H3Event, name: string): H3Event["context"][string];
 declare function getMethod(event: H3Event, defaultMethod?: HTTPMethod): HTTPMethod;
-/** @deprecated Use `h3.getMethod` */
-declare const useMethod: typeof getMethod;
 declare function isMethod(event: H3Event, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): boolean;
 declare function assertMethod(event: H3Event, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): void;
 declare function getRequestHeaders(event: H3Event): RequestHeaders;
@@ -278,11 +274,11 @@ declare const getHeader: typeof getRequestHeader;
 declare function send(event: H3Event, data?: any, type?: string): Promise<void>;
 declare function defaultContentType(event: H3Event, type?: string): void;
 declare function sendRedirect(event: H3Event, location: string, code?: number): Promise<void>;
-declare function getResponseHeaders(event: H3Event): ReturnType<H3Event['res']['getHeaders']>;
-declare function getResponseHeader(event: H3Event, name: string): ReturnType<H3Event['res']['getHeader']>;
-declare function setResponseHeaders(event: H3Event, headers: Record<string, Parameters<OutgoingMessage['setHeader']>[1]>): void;
+declare function getResponseHeaders(event: H3Event): ReturnType<H3Event["res"]["getHeaders"]>;
+declare function getResponseHeader(event: H3Event, name: string): ReturnType<H3Event["res"]["getHeader"]>;
+declare function setResponseHeaders(event: H3Event, headers: Record<string, Parameters<OutgoingMessage["setHeader"]>[1]>): void;
 declare const setHeaders: typeof setResponseHeaders;
-declare function setResponseHeader(event: H3Event, name: string, value: Parameters<OutgoingMessage['setHeader']>[1]): void;
+declare function setResponseHeader(event: H3Event, name: string, value: Parameters<OutgoingMessage["setHeader"]>[1]): void;
 declare const setHeader: typeof setResponseHeader;
 declare function appendResponseHeaders(event: H3Event, headers: Record<string, string>): void;
 declare const appendHeaders: typeof appendResponseHeaders;
@@ -305,4 +301,4 @@ interface CreateRouterOptions {
 }
 declare function createRouter(opts?: CreateRouterOptions): Router;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CreateRouterOptions, DynamicEventHandler, Encoding, EventHandler, EventHandlerResponse, H3Error, H3Event, H3EventContext, H3Headers, H3Response, HTTPMethod, InputLayer, InputStack, Layer, LazyEventHandler, MIMES, Matcher, NodeListener, NodeMiddleware, NodePromisifiedHandler, RequestHeaders, Router, RouterMethod, RouterUse, SendProxyOptions, Stack, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, readBody, readRawBody, send, sendError, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, toNodeListener, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody, writeEarlyHints };
+export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CreateRouterOptions, DynamicEventHandler, Encoding, EventHandler, EventHandlerResponse, H3Error, H3Event, H3EventContext, H3Headers, H3Response, HTTPMethod, InputLayer, InputStack, Layer, LazyEventHandler, MIMES, Matcher, NodeEventContext, NodeListener, NodeMiddleware, NodePromisifiedHandler, ProxyOptions, RequestHeaders, Router, RouterMethod, RouterUse, Stack, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callNodeListener, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineLazyEventHandler, defineNodeListener, defineNodeMiddleware, deleteCookie, dynamicEventHandler, eventHandler, fromNodeMiddleware, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, parseCookies, promisifyNodeListener, proxyRequest, readBody, readRawBody, send, sendError, sendProxy, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, toNodeListener, use, useBase, writeEarlyHints };