hono 4.13.9 → 4.13.11

package/dist/types/request.d.ts

@@ -1,293 +1,294 @@
-import { GET_MATCH_RESULT } from './request/constants';
-import type { Result } from './router';
-import type { Input, InputToDataByTarget, ParamKeyToRecord, ParamKeys, RemoveQuestion, RouterRoute, ValidationTargets } from './types';
-import type { BodyData, ParseBodyOptions } from './utils/body';
-import type { CustomHeader, RequestHeader } from './utils/headers';
-import type { Simplify, UnionToIntersection } from './utils/types';
+import { GET_MATCH_RESULT } from "./request/constants.js";
+import { Result } from "./router.js";
+import { CustomHeader, RequestHeader } from "./utils/headers.js";
+import { Simplify, UnionToIntersection } from "./utils/types.js";
+import { Input, InputToDataByTarget, ParamKeyToRecord, ParamKeys, RemoveQuestion, RouterRoute, ValidationTargets } from "./types.js";
+import { BodyData, ParseBodyOptions } from "./utils/body.js";
+//#region src/request.d.ts
 type Body = {
-    json: any;
-    text: string;
-    arrayBuffer: ArrayBuffer;
-    blob: Blob;
-    formData: FormData;
+  json: any;
+  text: string;
+  arrayBuffer: ArrayBuffer;
+  blob: Blob;
+  formData: FormData;
 };
 type BodyCache = Partial<Body>;
 export declare class HonoRequest<P extends string = '/', I extends Input['out'] = {}> {
-             
-    /**
-     * `.raw` can get the raw Request object.
-     *
-     * @see {@link https://hono.dev/docs/api/request#raw}
-     *
-     * @example
-     * ```ts
-     * // For Cloudflare Workers
-     * app.post('/', async (c) => {
-     *   const metadata = c.req.raw.cf?.hostMetadata?
-     *   ...
-     * })
-     * ```
-     */
-    raw: Request;
-    routeIndex: number;
-    /**
-     * `.path` can get the pathname of the request.
-     *
-     * @see {@link https://hono.dev/docs/api/request#path}
-     *
-     * @example
-     * ```ts
-     * app.get('/about/me', (c) => {
-     *   const pathname = c.req.path // `/about/me`
-     * })
-     * ```
-     */
-    path: string;
-    bodyCache: BodyCache;
-    constructor(request: Request, path?: string, matchResult?: Result<[unknown, RouterRoute]>);
-    /**
-     * `.req.param()` gets the path parameters.
-     *
-     * @see {@link https://hono.dev/docs/api/routing#path-parameter}
-     *
-     * @example
-     * ```ts
-     * const name = c.req.param('name')
-     * // or all parameters at once
-     * const { id, comment_id } = c.req.param()
-     * ```
-     */
-    param<P2 extends ParamKeys<P> = ParamKeys<P>>(key: string extends P ? never : P2 extends `${infer _}?` ? never : P2): string;
-    param<P2 extends RemoveQuestion<ParamKeys<P>> = RemoveQuestion<ParamKeys<P>>>(key: P2): string | undefined;
-    param(key: string): string | undefined;
-    param<P2 extends string = P>(): Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P2>>>>;
-    /**
-     * `.query()` can get querystring parameters.
-     *
-     * @see {@link https://hono.dev/docs/api/request#query}
-     *
-     * @example
-     * ```ts
-     * // Query params
-     * app.get('/search', (c) => {
-     *   const query = c.req.query('q')
-     * })
-     *
-     * // Get all params at once
-     * app.get('/search', (c) => {
-     *   const { q, limit, offset } = c.req.query()
-     * })
-     * ```
-     */
-    query(key: string): string | undefined;
-    query(): Record<string, string>;
-    /**
-     * `.queries()` can get multiple querystring parameter values, e.g. /search?tags=A&tags=B
-     *
-     * @see {@link https://hono.dev/docs/api/request#queries}
-     *
-     * @example
-     * ```ts
-     * app.get('/search', (c) => {
-     *   // tags will be string[]
-     *   const tags = c.req.queries('tags')
-     * })
-     * ```
-     */
-    queries(key: string): string[] | undefined;
-    queries(): Record<string, string[]>;
-    /**
-     * `.header()` can get the request header value.
-     *
-     * @see {@link https://hono.dev/docs/api/request#header}
-     *
-     * @example
-     * ```ts
-     * app.get('/', (c) => {
-     *   const userAgent = c.req.header('User-Agent')
-     * })
-     * ```
-     */
-    header(name: RequestHeader): string | undefined;
-    header(name: string): string | undefined;
-    header(): Record<RequestHeader | (string & CustomHeader), string>;
-    /**
-     * `.parseBody()` can parse Request body of type `multipart/form-data` or `application/x-www-form-urlencoded`
-     *
-     * @see {@link https://hono.dev/docs/api/request#parsebody}
-     *
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.parseBody()
-     * })
-     * ```
-     */
-    parseBody<Options extends Partial<ParseBodyOptions>, T extends BodyData<Options>>(options?: Options): Promise<T>;
-    parseBody<T extends BodyData>(options?: Partial<ParseBodyOptions>): Promise<T>;
-    /**
-     * `.json()` can parse Request body of type `application/json`
-     *
-     * @see {@link https://hono.dev/docs/api/request#json}
-     *
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.json()
-     * })
-     * ```
-     */
-    json<T = any>(): Promise<T>;
-    /**
-     * `.text()` can parse Request body of type `text/plain`
-     *
-     * @see {@link https://hono.dev/docs/api/request#text}
-     *
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.text()
-     * })
-     * ```
-     */
-    text(): Promise<string>;
-    /**
-     * `.arrayBuffer()` parse Request body as an `ArrayBuffer`
-     *
-     * @see {@link https://hono.dev/docs/api/request#arraybuffer}
-     *
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.arrayBuffer()
-     * })
-     * ```
-     */
-    arrayBuffer(): Promise<ArrayBuffer>;
-    /**
-     * `.bytes()` parses the request body as a `Uint8Array`.
-     *
-     * @see {@link https://hono.dev/docs/api/request#bytes}
-     *
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.bytes()
-     * })
-     * ```
-     */
-    bytes(): Promise<Uint8Array>;
-    /**
-     * Parses the request body as a `Blob`.
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.blob();
-     * });
-     * ```
-     * @see https://hono.dev/docs/api/request#blob
-     */
-    blob(): Promise<Blob>;
-    /**
-     * Parses the request body as `FormData`.
-     * @example
-     * ```ts
-     * app.post('/entry', async (c) => {
-     *   const body = await c.req.formData();
-     * });
-     * ```
-     * @see https://hono.dev/docs/api/request#formdata
-     */
-    formData(): Promise<FormData>;
-    /**
-     * Adds validated data to the request.
-     *
-     * @param target - The target of the validation.
-     * @param data - The validated data to add.
-     */
-    addValidatedData(target: keyof ValidationTargets, data: {}): void;
-    /**
-     * Gets validated data from the request.
-     *
-     * @param target - The target of the validation.
-     * @returns The validated data.
-     *
-     * @see https://hono.dev/docs/api/request#valid
-     */
-    valid<T extends keyof I & keyof ValidationTargets>(target: T): InputToDataByTarget<I, T>;
-    /**
-     * `.url()` can get the request url strings.
-     *
-     * @see {@link https://hono.dev/docs/api/request#url}
-     *
-     * @example
-     * ```ts
-     * app.get('/about/me', (c) => {
-     *   const url = c.req.url // `http://localhost:8787/about/me`
-     *   ...
-     * })
-     * ```
-     */
-    get url(): string;
-    /**
-     * `.method()` can get the method name of the request.
-     *
-     * @see {@link https://hono.dev/docs/api/request#method}
-     *
-     * @example
-     * ```ts
-     * app.get('/about/me', (c) => {
-     *   const method = c.req.method // `GET`
-     * })
-     * ```
-     */
-    get method(): string;
-    get [GET_MATCH_RESULT](): Result<[unknown, RouterRoute]>;
-    /**
-     * `.matchedRoutes()` can return a matched route in the handler
-     *
-     * @deprecated
-     *
-     * Use matchedRoutes helper defined in "hono/route" instead.
-     *
-     * @see {@link https://hono.dev/docs/api/request#matchedroutes}
-     *
-     * @example
-     * ```ts
-     * app.use('*', async function logger(c, next) {
-     *   await next()
-     *   c.req.matchedRoutes.forEach(({ handler, method, path }, i) => {
-     *     const name = handler.name || (handler.length < 2 ? '[handler]' : '[middleware]')
-     *     console.log(
-     *       method,
-     *       ' ',
-     *       path,
-     *       ' '.repeat(Math.max(10 - path.length, 0)),
-     *       name,
-     *       i === c.req.routeIndex ? '<- respond from here' : ''
-     *     )
-     *   })
-     * })
-     * ```
-     */
-    get matchedRoutes(): RouterRoute[];
-    /**
-     * `routePath()` can retrieve the path registered within the handler
-     *
-     * @deprecated
-     *
-     * Use routePath helper defined in "hono/route" instead.
-     *
-     * @see {@link https://hono.dev/docs/api/request#routepath}
-     *
-     * @example
-     * ```ts
-     * app.get('/posts/:id', (c) => {
-     *   return c.json({ path: c.req.routePath })
-     * })
-     * ```
-     */
-    get routePath(): string;
+  
+  /**
+   * `.raw` can get the raw Request object.
+   *
+   * @see {@link https://hono.dev/docs/api/request#raw}
+   *
+   * @example
+   * ```ts
+   * // For Cloudflare Workers
+   * app.post('/', async (c) => {
+   *   const metadata = c.req.raw.cf?.hostMetadata?
+   *   ...
+   * })
+   * ```
+   */
+  raw: Request;
+  routeIndex: number;
+  /**
+   * `.path` can get the pathname of the request.
+   *
+   * @see {@link https://hono.dev/docs/api/request#path}
+   *
+   * @example
+   * ```ts
+   * app.get('/about/me', (c) => {
+   *   const pathname = c.req.path // `/about/me`
+   * })
+   * ```
+   */
+  path: string;
+  bodyCache: BodyCache;
+  constructor(request: Request, path?: string, matchResult?: Result<[unknown, RouterRoute]>);
+  /**
+   * `.req.param()` gets the path parameters.
+   *
+   * @see {@link https://hono.dev/docs/api/routing#path-parameter}
+   *
+   * @example
+   * ```ts
+   * const name = c.req.param('name')
+   * // or all parameters at once
+   * const { id, comment_id } = c.req.param()
+   * ```
+   */
+  param<P2 extends ParamKeys<P> = ParamKeys<P>>(key: string extends P ? never : P2 extends `${infer _}?` ? never : P2): string;
+  param<P2 extends RemoveQuestion<ParamKeys<P>> = RemoveQuestion<ParamKeys<P>>>(key: P2): string | undefined;
+  param(key: string): string | undefined;
+  param<P2 extends string = P>(): Simplify<UnionToIntersection<ParamKeyToRecord<ParamKeys<P2>>>>;
+  /**
+   * `.query()` can get querystring parameters.
+   *
+   * @see {@link https://hono.dev/docs/api/request#query}
+   *
+   * @example
+   * ```ts
+   * // Query params
+   * app.get('/search', (c) => {
+   *   const query = c.req.query('q')
+   * })
+   *
+   * // Get all params at once
+   * app.get('/search', (c) => {
+   *   const { q, limit, offset } = c.req.query()
+   * })
+   * ```
+   */
+  query(key: string): string | undefined;
+  query(): Record<string, string>;
+  /**
+   * `.queries()` can get multiple querystring parameter values, e.g. /search?tags=A&tags=B
+   *
+   * @see {@link https://hono.dev/docs/api/request#queries}
+   *
+   * @example
+   * ```ts
+   * app.get('/search', (c) => {
+   *   // tags will be string[]
+   *   const tags = c.req.queries('tags')
+   * })
+   * ```
+   */
+  queries(key: string): string[] | undefined;
+  queries(): Record<string, string[]>;
+  /**
+   * `.header()` can get the request header value.
+   *
+   * @see {@link https://hono.dev/docs/api/request#header}
+   *
+   * @example
+   * ```ts
+   * app.get('/', (c) => {
+   *   const userAgent = c.req.header('User-Agent')
+   * })
+   * ```
+   */
+  header(name: RequestHeader): string | undefined;
+  header(name: string): string | undefined;
+  header(): Record<RequestHeader | (string & CustomHeader), string>;
+  /**
+   * `.parseBody()` can parse Request body of type `multipart/form-data` or `application/x-www-form-urlencoded`
+   *
+   * @see {@link https://hono.dev/docs/api/request#parsebody}
+   *
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.parseBody()
+   * })
+   * ```
+   */
+  parseBody<Options extends Partial<ParseBodyOptions>, T extends BodyData<Options>>(options?: Options): Promise<T>;
+  parseBody<T extends BodyData>(options?: Partial<ParseBodyOptions>): Promise<T>;
+  /**
+   * `.json()` can parse Request body of type `application/json`
+   *
+   * @see {@link https://hono.dev/docs/api/request#json}
+   *
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.json()
+   * })
+   * ```
+   */
+  json<T = any>(): Promise<T>;
+  /**
+   * `.text()` can parse Request body of type `text/plain`
+   *
+   * @see {@link https://hono.dev/docs/api/request#text}
+   *
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.text()
+   * })
+   * ```
+   */
+  text(): Promise<string>;
+  /**
+   * `.arrayBuffer()` parse Request body as an `ArrayBuffer`
+   *
+   * @see {@link https://hono.dev/docs/api/request#arraybuffer}
+   *
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.arrayBuffer()
+   * })
+   * ```
+   */
+  arrayBuffer(): Promise<ArrayBuffer>;
+  /**
+   * `.bytes()` parses the request body as a `Uint8Array`.
+   *
+   * @see {@link https://hono.dev/docs/api/request#bytes}
+   *
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.bytes()
+   * })
+   * ```
+   */
+  bytes(): Promise<Uint8Array>;
+  /**
+   * Parses the request body as a `Blob`.
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.blob();
+   * });
+   * ```
+   * @see https://hono.dev/docs/api/request#blob
+   */
+  blob(): Promise<Blob>;
+  /**
+   * Parses the request body as `FormData`.
+   * @example
+   * ```ts
+   * app.post('/entry', async (c) => {
+   *   const body = await c.req.formData();
+   * });
+   * ```
+   * @see https://hono.dev/docs/api/request#formdata
+   */
+  formData(): Promise<FormData>;
+  /**
+   * Adds validated data to the request.
+   *
+   * @param target - The target of the validation.
+   * @param data - The validated data to add.
+   */
+  addValidatedData(target: keyof ValidationTargets, data: {}): void;
+  /**
+   * Gets validated data from the request.
+   *
+   * @param target - The target of the validation.
+   * @returns The validated data.
+   *
+   * @see https://hono.dev/docs/api/request#valid
+   */
+  valid<T extends keyof I & keyof ValidationTargets>(target: T): InputToDataByTarget<I, T>;
+  /**
+   * `.url()` can get the request url strings.
+   *
+   * @see {@link https://hono.dev/docs/api/request#url}
+   *
+   * @example
+   * ```ts
+   * app.get('/about/me', (c) => {
+   *   const url = c.req.url // `http://localhost:8787/about/me`
+   *   ...
+   * })
+   * ```
+   */
+  get url(): string;
+  /**
+   * `.method()` can get the method name of the request.
+   *
+   * @see {@link https://hono.dev/docs/api/request#method}
+   *
+   * @example
+   * ```ts
+   * app.get('/about/me', (c) => {
+   *   const method = c.req.method // `GET`
+   * })
+   * ```
+   */
+  get method(): string;
+  get [GET_MATCH_RESULT](): Result<[unknown, RouterRoute]>;
+  /**
+   * `.matchedRoutes()` can return a matched route in the handler
+   *
+   * @deprecated
+   *
+   * Use matchedRoutes helper defined in "hono/route" instead.
+   *
+   * @see {@link https://hono.dev/docs/api/request#matchedroutes}
+   *
+   * @example
+   * ```ts
+   * app.use('*', async function logger(c, next) {
+   *   await next()
+   *   c.req.matchedRoutes.forEach(({ handler, method, path }, i) => {
+   *     const name = handler.name || (handler.length < 2 ? '[handler]' : '[middleware]')
+   *     console.log(
+   *       method,
+   *       ' ',
+   *       path,
+   *       ' '.repeat(Math.max(10 - path.length, 0)),
+   *       name,
+   *       i === c.req.routeIndex ? '<- respond from here' : ''
+   *     )
+   *   })
+   * })
+   * ```
+   */
+  get matchedRoutes(): RouterRoute[];
+  /**
+   * `routePath()` can retrieve the path registered within the handler
+   *
+   * @deprecated
+   *
+   * Use routePath helper defined in "hono/route" instead.
+   *
+   * @see {@link https://hono.dev/docs/api/request#routepath}
+   *
+   * @example
+   * ```ts
+   * app.get('/posts/:id', (c) => {
+   *   return c.json({ path: c.req.routePath })
+   * })
+   * ```
+   */
+  get routePath(): string;
 }
 /**
  * Clones a HonoRequest's underlying raw Request object.
@@ -321,4 +322,4 @@ export declare class HonoRequest<P extends string = '/', I extends Input['out']
  * ```
  */
 export declare const cloneRawRequest: (req: HonoRequest) => Promise<Request>;
-export {};
+//#endregion

package/dist/types/router/linear-router/index.d.ts

@@ -1,5 +1,2 @@
-/**
- * @module
- * LinearRouter for Hono.
- */
-export { LinearRouter } from './router';
+import { LinearRouter } from "./router.js";
+export { LinearRouter };

package/dist/types/router/linear-router/router.d.ts

@@ -1,7 +1,9 @@
-import type { Result, Router } from '../../router';
+import { Result, Router } from "../../router.js";
+//#region src/router/linear-router/router.d.ts
 export declare class LinearRouter<T> implements Router<T> {
-             
-    name: string;
-    add(method: string, path: string, handler: T): void;
-    match(method: string, path: string): Result<T>;
+  
+  name: string;
+  add(method: string, path: string, handler: T): void;
+  match(method: string, path: string): Result<T>;
 }
+//#endregion

package/dist/types/router/pattern-router/index.d.ts

@@ -1,5 +1,2 @@
-/**
- * @module
- * PatternRouter for Hono.
- */
-export { PatternRouter } from './router';
+import { PatternRouter } from "./router.js";
+export { PatternRouter };

package/dist/types/router/pattern-router/router.d.ts

@@ -1,7 +1,9 @@
-import type { Result, Router } from '../../router';
+import { Result, Router } from "../../router.js";
+//#region src/router/pattern-router/router.d.ts
 export declare class PatternRouter<T> implements Router<T> {
-             
-    name: string;
-    add(method: string, path: string, handler: T): void;
-    match(method: string, path: string): Result<T>;
+  
+  name: string;
+  add(method: string, path: string, handler: T): void;
+  match(method: string, path: string): Result<T>;
 }
+//#endregion

package/dist/types/router/reg-exp-router/index.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module
- * RegExpRouter for Hono.
- */
-export { RegExpRouter } from './router';
-export { PreparedRegExpRouter, buildInitParams, serializeInitParams } from './prepared-router';
+import { RegExpRouter } from "./router.js";
+import { PreparedRegExpRouter, buildInitParams, serializeInitParams } from "./prepared-router.js";
+export { PreparedRegExpRouter, RegExpRouter, buildInitParams, serializeInitParams };