29 lines
986 B
TypeScript
29 lines
986 B
TypeScript
|
import type { HttpBindings } from '@hono/node-server';
|
||
|
|
import type { MiddlewareHandler } from 'hono';
|
||
|
|
import { type Options } from './index.js';
|
||
|
|
/**
|
||
|
|
* Creates a Hono middleware that proxies requests using http-proxy-middleware.
|
||
|
|
*
|
||
|
|
* @remarks
|
||
|
|
* This middleware requires Hono to be running on Node.js via `@hono/node-server`.
|
||
|
|
* It uses `c.env.incoming` and `c.env.outgoing` which are only available with `HttpBindings`.
|
||
|
|
*
|
||
|
|
* @experimental This API is experimental and may change without a major version bump.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* import { serve } from '@hono/node-server';
|
||
|
|
* import { Hono } from 'hono';
|
||
|
|
* import { createHonoProxyMiddleware } from 'http-proxy-middleware/hono';
|
||
|
|
*
|
||
|
|
* const app = new Hono();
|
||
|
|
* app.use('/api', createHonoProxyMiddleware({ target: 'http://example.com', changeOrigin: true }));
|
||
|
|
* serve(app);
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @since 4.0.0
|
||
|
|
*/
|
||
|
|
export declare function createHonoProxyMiddleware(options: Options): MiddlewareHandler<{
|
||
|
|
Bindings: HttpBindings;
|
||
|
|
}>;
|