Skip to content
Shokupan

ProxyOptions

Defined in: src/plugins/middleware/proxy.ts:5

Properties

Section titled “Properties”
Property Type Description Defined in

allowedHosts?

string[]

Whitelist of allowed target hosts.

src/plugins/middleware/proxy.ts:29

allowPrivateIPs?

boolean

Whether to allow private IPs (disabled by default).

src/plugins/middleware/proxy.ts:33

changeOrigin?

boolean

Whether to change the origin of the request.

src/plugins/middleware/proxy.ts:17

headers?

Record<string, string>

Additional headers to send with the request.

src/plugins/middleware/proxy.ts:25

pathRewrite?

(path) => string

Function to rewrite the path of the request.

src/plugins/middleware/proxy.ts:13

target

string

Target URL to proxy requests to.

src/plugins/middleware/proxy.ts:9

ws?

boolean

Whether to proxy WebSocket connections.

src/plugins/middleware/proxy.ts:21