![\"\"](\"https://img.shields.io/npm/v/@refactorjs/http-proxy.svg?style=flat-square\")
\r\n\r\n\r\n ![\"\"](\"https://img.shields.io/npm/dt/@refactorjs/http-proxy.svg?style=flat-square\")
\r\n\r\nAn Alternative to HTTP Proxy
\r\n\r\n\r\n\r\n## Description\r\n\r\nThis is meant as a project to convert `node-http-proxy/http-proxy` to typescript. While also incorporating some of the pull requests that were left unanswered/uncomitted that were useful.\r\n\r\n## Development\r\n\r\nRunning tests for development:\r\n\r\n```bash\r\n$ npm install\r\n$ npm run build\r\n$ npm run test\r\n```\r\n\r\n## Options\r\n\r\n`ProxySever | createProxyServer | createServer | createProxy` supports the following options:\r\n\r\n- **target:** `string` - url string to be parsed with the url module\r\n- **forward:** `string` - url string to be parsed with the url module\r\n- **agent:** `object` - object to be passed to http(s).request (see Node's [https agent](http://nodejs.org/api/https.html#https_class_https_agent) and [http agent](http://nodejs.org/api/http.html#http_class_http_agent) objects)\r\n- **ssl:** `object` - object to be passed to https.createServer()\r\n- **ws:** `boolean`- if you want to proxy websockets\r\n- **xfwd:** `boolean` - adds x-forward headers\r\n- **secure:** `boolean` - if you want to verify the SSL Certs\r\n- **toProxy:** `boolean` - passes the absolute URL as the `path` (useful for proxying to proxies)\r\n- **prependPath:** `boolean` - Default: true - specify whether you want to prepend the target's path to the proxy path\r\n- **ignorePath:** `boolean` - Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).\r\n- **localAddress:** `string` Local interface string to bind for outgoing connections\r\n- ~~**changeOrigin:** `boolean` - Default: false - changes the origin of the host header to the target URL~~ | `deprecated`\r\n- **changeHost:** `boolean` - Default: false - changes the origin of the host header to the target URL\r\n- **preserveHeaderKeyCase:** `boolean` - Default: false - specify whether you want to keep letter case of response header key\r\n- **auth:** `string` - Basic authentication i.e. 'user:password' to compute an Authorization header.\r\n- **hostRewrite:** `string` - rewrites the location hostname on (201/301/302/303/307/308) redirects.\r\n- **autoRewrite:** `boolean` - rewrites the location host/port on (201/301/302/303/307/308) redirects based on requested host/port. Default: false.\r\n- **protocolRewrite:** `http|https|null` - rewrites the location protocol on (201/301/302/307/308) redirects to 'http' or 'https'.\r\n- **cookieDomainRewrite:** `false|string|object` - rewrites domain of `set-cookie` headers. Possible values:\r\n * `false` (default): disable cookie rewriting\r\n * `string`: new domain, for example `cookieDomainRewrite: \"new.domain\"`. To remove the domain, use `cookieDomainRewrite: \"\"`.\r\n * `object`: mapping of domains to new domains, use `\"*\"` to match all domains.\r\n For example keep one domain unchanged, rewrite one domain and remove other domains:\r\n ```ts\r\n cookieDomainRewrite: {\r\n \"unchanged.domain\": \"unchanged.domain\",\r\n \"old.domain\": \"new.domain\",\r\n \"*\": \"\"\r\n }\r\n ```\r\n\r\n- **cookiePathRewrite:** `false|string|object` - rewrites path of `set-cookie` headers. Possible values:\r\n * `false` (default): disable cookie rewriting\r\n * `string`: new path, for example `cookiePathRewrite: \"/newPath/\"`. To remove the path, use `cookiePathRewrite: \"\"`. To set path to root use `cookiePathRewrite: \"/\"`.\r\n * `object`: mapping of paths to new paths, use `\"*\"` to match all paths.\r\n For example, to keep one path unchanged, rewrite one path and remove other paths:\r\n ```ts\r\n cookiePathRewrite: {\r\n \"/unchanged.path/\": \"/unchanged.path/\",\r\n \"/old.path/\": \"/new.path/\",\r\n \"*\": \"\"\r\n }\r\n ```\r\n- **cookieRemoveSecure:** `boolean` - specify if you want to remove the secure flag from the cookie\r\n- **mergeCookies:** `boolean` - allows to merge `set-cookie` headers from passed response and response from target. Default: false.\r\n- **headers:** `object` - object with extra headers to be added to target requests.\r\n- **outgoingHeaders:** `object` - object with extra headers to be added to proxy requests.\r\n- **proxyTimeout:** `number` - timeout (in millis) for outgoing proxy requests\r\n- **proxyTimeoutCustomError**: `boolean` - specify whether you want to throw a custom `ETIMEDOUT` error when the `proxyTimeout` is reached. If false then the default `ECONNRESET` error will be thrown. Default: false.\r\n- **timeout:** `number` - timeout (in millis) for incoming requests\r\n- **followRedirects:** `boolean` - Default: false - specify whether you want to follow redirects\r\n- **forcePasses:** `boolean` - if set to true the web passes will be run even if `selfHandleResponse` is also set to true. (Default: false)\r\n- **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\r\n- **createWsClientTransformStream:** `function|null` - if set, this function will be called with three arguments `req`, `proxyReq` and `proxyRes` and should return a Duplex stream, data from the client websocket will be piped through this stream before being piped to the server, allowing you to influence the request data.\r\n- **createWsServerTransformStream:** `function|null` - if set, this function will be called with three arguments `req`, `proxyReq` and `proxyRes` and should return a Duplex stream, data from the server websocket will be piped through this stream before being piped to the client, allowing you to influence the response data.\r\n- **buffer:** `Buffer` - stream of data to send as the request body. Maybe you have some middleware that consumes the request stream before proxying it on e.g. If you read the body of a request into a field called 'req.rawbody' you could restream this field in the buffer option:\r\n ```ts\r\n import streamify from 'stream-array'\r\n import { ProxyServer } from '@refactorjs/http-proxy'\r\n const proxy = new ProxyServer();\r\n\r\n export function (req, res, next) {\r\n proxy.web(req, res, {\r\n target: 'http://localhost:4003/',\r\n buffer: streamify(req.rawBody)\r\n }, next);\r\n }\r\n ```\r\n- **lookup:** `undefined|function` define a custom dns [lookup](https://nodejs.org/docs/latest-v12.x/api/dns.html#dns_dns_lookup_hostname_options_callback) function to use when resolving target/forward hostnames.\r\n ```js\r\n // Example: add dns caching\r\n import dlc from 'dns-lookup-cache'\r\n import { ProxyServer } from '@refactorjs/http-proxy'\r\n const proxy = new ProxyServer();\r\n\r\n export function (req, res, next) {\r\n proxy.web(req, res, {\r\n target: 'http://example.com',\r\n lookup: dlc.lookup,\r\n }, next);\r\n }\r\n ```\r\n\r\n#### NOTE:\r\n`options.ws` and `options.ssl` are optional.\r\n`options.target` and `options.forward` cannot both be missing.\r\n\r\nIf you are using the `listen` method, the following options are also applicable:\r\n\r\n- **ssl:** `object` - object to be passed to https.createServer()\r\n- **ws:** `boolean` - if you want to proxy websockets","readmeFilename":"README.md"}