Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop recommending tunnel package #1851

Merged
merged 2 commits into from
Aug 22, 2021
Merged

Stop recommending tunnel package #1851

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bafe995
Stop recommending `tunnel` package
szmarczak Aug 22, 2021
8de7d37
style
szmarczak Aug 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions documentation/tips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,24 +154,14 @@ scope.persist(false);

### Proxying

You can use the [`tunnel`](https://github.com/koichik/node-tunnel) package with the `agent` option to work with proxies:

```js
import got from 'got';
import tunnel from 'tunnel';
**Note:**
> - The popular [`tunnel`](https://www.npmjs.com/package/tunnel) package is unmaintained. Use at your own risk.
> - The [`proxy-agent`](https://www.npmjs.com/package/proxy-agent) family doesn't follow newest Node.js features and lacks support.

await got('https://sindresorhus.com', {
agent: {
https: tunnel.httpsOverHttp({
proxy: {
host: 'localhost'
}
})
}
});
```
Although there isn't a perfect, bug-free package, [Apify](https://apify.com/)'s solution is a modern one.\
See [`got-scraping/src/agent/h1-proxy-agent.ts`](https://github.com/apify/got-scraping/blob/2ec7f9148917a6a38d6d1c8c695606767c46cce5/src/agent/h1-proxy-agent.ts). It has the same API as `hpagent`.

Otherwise, you can use the [`hpagent`](https://github.com/delvedor/hpagent) package, which keeps the internal sockets alive to be reused.
[`hpagent`](https://github.com/delvedor/hpagent) is a modern package as well. In contrast to `tunnel`, it allows keeping the internal sockets alive to be reused.

```js
import got from 'got';
Expand Down