h3-proxy

A proxy event handler for h3, using proxyRequest.

Features

• Powerd by built-in proxyRequest of h3.
• Support Typescript.

Installation

# pnpm
$ pnpm add h3-proxy

# yarn
$ yarn add h3-proxy

# npm
$ npm i h3-proxy

Usage

import { createServer } from 'node:http'
import { createApp, eventHandler, toNodeListener } from 'h3'
import { createProxyEventHandler } from 'h3-proxy'

const app = createApp()

const port = process.env.PORT || 3000

const proxyEventHandler = createProxyEventHandler({
  target: `http://127.0.0.1:${port}`,
  pathRewrite: {
    '/api': '',
  },
  pathFilter: ['/api/**'],
})

app.use(
  '/test',
  eventHandler(() => 'Hello world!')
)

app.use(eventHandler(proxyEventHandler))

createServer(toNodeListener(app)).listen(port)

APIs

createProxyEventHandler

Create a h3 event handler that can handle proxy requests.

Options

| Key | Type | Required | Description | | target | string | true | Proxy target address, including protocol, host and port. | | pathFilter | string | string[] | glob | glob[] | Function | false | Narrow down which requests should be proxied. | | pathRewrite | object/Function | false | Rewrite target's url path. Object-keys will be used as RegExp to match paths. |

CHANGE LOG

SEE CHANGE LOG.