Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

agent?: any

Object to be passed to http(s).request.

auth?: string

Basic authentication i.e. 'user:password' to compute an Authorization header.

autoRewrite?: boolean

Rewrites the location host/ port on (301 / 302 / 307 / 308) redirects based on requested host/ port.Default: false.

buffer?: Stream

Buffer

changeOrigin?: boolean

Changes the origin of the host header to the target URL.

cookieDomainRewrite?: string | false | {}

rewrites domain of set-cookie headers.

cookiePathRewrite?: string | false | {}

rewrites path of set-cookie headers. Default: false

followRedirects?: boolean

Specify whether you want to follow redirects. Default: false

forward?: ProxyTargetUrl

URL string to be parsed with the url module.

headers?: {}

object with extra headers to be added to target requests.

Type declaration

  • [header: string]: string
hostRewrite?: string

Rewrites the location hostname on (301 / 302 / 307 / 308) redirects, Default: null.

ignorePath?: boolean

Specify whether you want to ignore the proxy path of the incoming request.

localAddress?: string

Local interface string to bind for outgoing connections.

prependPath?: boolean

Specify whether you want to prepend the target's path to the proxy path.

preserveHeaderKeyCase?: boolean

specify whether you want to keep letter case of response header key

protocolRewrite?: string

Rewrites the location protocol on (301 / 302 / 307 / 308) redirects to 'http' or 'https'.Default: null.

proxyTimeout?: number

Timeout (in milliseconds) when proxy receives no response from target. Default: 120000 (2 minutes)

secure?: boolean

Verify SSL certificate.

selfHandleResponse?: boolean

If set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the proxyRes event

ssl?: any

Object to be passed to https.createServer().

target?: ProxyTarget

URL string to be parsed with the url module.

timeout?: number

Timeout (in milliseconds) for incoming requests

toProxy?: boolean

Explicitly specify if we are proxying to another proxy.

ws?: boolean

If you want to proxy websockets.

xfwd?: boolean

Adds x- forward headers.

Methods

  • bypass(req: IncomingMessage, res: ServerResponse<IncomingMessage>, options: ProxyOptions): undefined | null | string | false | void
  • webpack-dev-server style bypass function

    Parameters

    • req: IncomingMessage
    • res: ServerResponse<IncomingMessage>
    • options: ProxyOptions

    Returns undefined | null | string | false | void

  • configure the proxy server (e.g. listen to events)

    Parameters

    Returns void

  • rewrite(path: string): string
  • rewrite path

    Parameters

    • path: string

    Returns string