h3 - npm Package Compare versions

Comparing version 0.7.13 to 0.7.14

dist/index.d.ts

@@ -1,2 +0,2 @@
-import http from 'http';
+import http, { OutgoingMessage } from 'http';
 import { CookieSerializeOptions } from 'cookie-es';
@@ -155,3 +155,5 @@ import * as ufo from 'ufo';
  */
-declare function useRawBody(event: CompatibilityEvent, encoding?: Encoding): Encoding extends false ? Buffer : Promise<string | Buffer>;
+declare function readRawBody(event: CompatibilityEvent, encoding?: Encoding): Encoding extends false ? Buffer : Promise<string | Buffer>;
+/** @deprecated Use `h3.readRawBody` */
+declare const useRawBody: typeof readRawBody;
 /**
@@ -168,3 +170,5 @@ * Reads request body and try to safely parse using [destr](https://github.com/unjs/destr)
  */
-declare function useBody<T = any>(event: CompatibilityEvent): Promise<T>;
+declare function readBody<T = any>(event: CompatibilityEvent): Promise<T>;
+/** @deprecated Use `h3.readBody` */
+declare const useBody: typeof readBody;
 
@@ -194,6 +198,8 @@ interface CacheConditions {
  * ```ts
- * const cookies = useCookies(req)
+ * const cookies = parseCookies(event)
  * ```
  */
-declare function useCookies(event: CompatibilityEvent): Record<string, string>;
+declare function parseCookies(event: CompatibilityEvent): Record<string, string>;
+/** @deprecated Use `h3.parseCookies` */
+declare const useCookies: typeof parseCookies;
 /**
@@ -208,3 +214,5 @@ * Get a cookie value by name.
  */
-declare function useCookie(event: CompatibilityEvent, name: string): string | undefined;
+declare function getCookie(event: CompatibilityEvent, name: string): string | undefined;
+/** @deprecated Use `h3.getCookie` */
+declare const useCookie: typeof getCookie;
 /**
@@ -232,6 +240,16 @@ * Set a cookie value by name.
 
-declare function useQuery(event: CompatibilityEvent): ufo.QueryObject;
-declare function useMethod(event: CompatibilityEvent, defaultMethod?: HTTPMethod): HTTPMethod;
+declare function getQuery(event: CompatibilityEvent): ufo.QueryObject;
+/** @deprecated Use `h3.getQuery` */
+declare const useQuery: typeof getQuery;
+declare function getRouterParams(event: CompatibilityEvent): CompatibilityEvent['context'];
+declare function getRouterParam(event: CompatibilityEvent, name: string): CompatibilityEvent['context'][string];
+declare function getMethod(event: CompatibilityEvent, defaultMethod?: HTTPMethod): HTTPMethod;
+/** @deprecated Use `h3.getMethod` */
+declare const useMethod: typeof getMethod;
 declare function isMethod(event: CompatibilityEvent, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): boolean;
 declare function assertMethod(event: CompatibilityEvent, expected: HTTPMethod | HTTPMethod[], allowHead?: boolean): void;
+declare function getRequestHeaders(event: CompatibilityEvent): CompatibilityEvent['req']['headers'];
+declare const getHeaders: typeof getRequestHeaders;
+declare function getRequestHeader(event: CompatibilityEvent, name: string): CompatibilityEvent['req']['headers'][string];
+declare const getHeader: typeof getRequestHeader;
 
@@ -241,3 +259,12 @@ declare function send(event: CompatibilityEvent, data?: any, type?: string): Promise<void>;
 declare function sendRedirect(event: CompatibilityEvent, location: string, code?: number): Promise<void>;
-declare function appendHeader(event: CompatibilityEvent, name: string, value: string): void;
+declare function getResponseHeaders(event: CompatibilityEvent): ReturnType<CompatibilityEvent['res']['getHeaders']>;
+declare function getResponseHeader(event: CompatibilityEvent, name: string): ReturnType<CompatibilityEvent['res']['getHeader']>;
+declare function setResponseHeaders(event: CompatibilityEvent, headers: Record<string, Parameters<OutgoingMessage['setHeader']>[1]>): void;
+declare const setHeaders: typeof setResponseHeaders;
+declare function setResponseHeader(event: CompatibilityEvent, name: string, value: Parameters<OutgoingMessage['setHeader']>[1]): void;
+declare const setHeader: typeof setResponseHeader;
+declare function appendResponseHeaders(event: CompatibilityEvent, headers: Record<string, string>): void;
+declare const appendHeaders: typeof appendResponseHeaders;
+declare function appendResponseHeader(event: CompatibilityEvent, name: string, value: string): void;
+declare const appendHeader: typeof appendResponseHeader;
 declare function isStream(data: any): any;
@@ -256,2 +283,2 @@ declare function sendStream(event: CompatibilityEvent, data: any): Promise<void>;
 
-export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CompatibilityEvent, CompatibilityEventHandler, DynamicEventHandler, Encoding, EventHandler, H3Error, H3Event, H3EventContext, H3Response, HTTPMethod, Handler, IncomingMessage, InputLayer, InputStack, Layer, LazyEventHandler, LazyHandler, MIMES, Matcher, Middleware, NodeHandler, PromisifiedHandler, Router, RouterMethod, RouterUse, ServerResponse, Stack, appendHeader, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, lazyHandle, promisifyHandle, promisifyHandler, send, sendError, sendRedirect, sendStream, setCookie, toEventHandler, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };
+export { AddRouteShortcuts, App, AppOptions, AppUse, CacheConditions, CompatibilityEvent, CompatibilityEventHandler, DynamicEventHandler, Encoding, EventHandler, H3Error, H3Event, H3EventContext, H3Response, HTTPMethod, Handler, IncomingMessage, InputLayer, InputStack, Layer, LazyEventHandler, LazyHandler, MIMES, Matcher, Middleware, NodeHandler, PromisifiedHandler, Router, RouterMethod, RouterUse, ServerResponse, Stack, appendHeader, appendHeaders, appendResponseHeader, appendResponseHeaders, assertMethod, callHandler, createApp, createAppEventHandler, createError, createEvent, createRouter, defaultContentType, defineEventHandler, defineHandle, defineHandler, defineLazyEventHandler, defineLazyHandler, defineMiddleware, deleteCookie, dynamicEventHandler, eventHandler, getCookie, getHeader, getHeaders, getMethod, getQuery, getRequestHeader, getRequestHeaders, getResponseHeader, getResponseHeaders, getRouterParam, getRouterParams, handleCacheHeaders, isError, isEvent, isEventHandler, isMethod, isStream, lazyEventHandler, lazyHandle, parseCookies, promisifyHandle, promisifyHandler, readBody, readRawBody, send, sendError, sendRedirect, sendStream, setCookie, setHeader, setHeaders, setResponseHeader, setResponseHeaders, toEventHandler, use, useBase, useBody, useCookie, useCookies, useMethod, useQuery, useRawBody };

package.json

 {
   "name": "h3",
-  "version": "0.7.13",
+  "version": "0.7.14",
   "description": "Tiny JavaScript Server",
@@ -48,3 +48,3 @@ "repository": "unjs/h3",
   },
-  "packageManager": "pnpm@7.8.0",
+  "packageManager": "pnpm@7.9.0",
   "scripts": {
@@ -51,0 +51,0 @@ "build": "unbuild",

README.md

@@ -115,2 +115,4 @@ [![npm downloads](https://img.shields.io/npm/dm/h3.svg?style=flat-square)](https://npmjs.com/package/h3)
 
+### Built-in
+
 Instead of adding helpers to `req` and `res`, h3 exposes them as composable utilities.
@@ -125,5 +127,11 @@
 - `useQuery(req)`
+- `getRouterParams(event)`
 - `send(res, data, type?)`
 - `sendRedirect(res, location, code=302)`
-- `appendHeader(res, name, value)`
+- `getRequestHeaders(event, headers)` (alias: `getHeaders`)
+- `getRequestHeader(event, name)` (alias: `getHeader`)
+- `setResponseHeaders(event, headers)` (alias: `setHeaders`)
+- `setResponseHeader(event, name, value)` (alias: `setHeader`)
+- `appendResponseHeaders(event, headers)` (alias: `appendHeaders`)
+- `appendResponseHeader(event, name, value)` (alias: `appendHeader`)
 - `createError({ statusCode, statusMessage, data? })`
@@ -139,2 +147,9 @@ - `sendError(res, error, debug?)`
 
+### Add-ons
+
+More composable utilities can be found in community packages.
+
+- `validateBody(event, schema)` from [h3-typebox](https://github.com/kevinmarrec/h3-typebox)
+- `validateQuery(event, schema)` from [h3-typebox](https://github.com/kevinmarrec/h3-typebox)
+
 ## How it works?
@@ -141,0 +156,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

59893

increased by12.67%

Lines of code

1469

increased by10.04%

Number of lines in readme file

168

increased by9.8%

No dependency changes