socks-proxy-agent

A SOCKS proxy http.Agent implementation for HTTP and HTTPS

This module provides an http.Agent implementation that connects to a specified SOCKS proxy server, and can be used with the built-in http and https modules.

It can also be used in conjunction with the ws module to establish a WebSocket connection over a SOCKS proxy. See the "Examples" section below.

Examples

1import https from 'https';
2import { SocksProxyAgent } from 'socks-proxy-agent';
3
4const agent = new SocksProxyAgent(
5	'socks://your-name%40gmail.com:abcdef12345124@br41.nordvpn.com'
6);
7
8https.get('https://ipinfo.io', { agent }, (res) => {
9	console.log(res.headers);
10	res.pipe(process.stdout);
11});

ws WebSocket connection example

1import WebSocket from 'ws';
2import { SocksProxyAgent } from 'socks-proxy-agent';
3
4const agent = new SocksProxyAgent(
5	'socks://your-name%40gmail.com:abcdef12345124@br41.nordvpn.com'
6);
7
8var socket = new WebSocket('ws://echo.websocket.events', { agent });
9
10socket.on('open', function () {
11	console.log('"open" event!');
12	socket.send('hello world');
13});
14
15socket.on('message', function (data, flags) {
16	console.log('"message" event! %j %j', data, flags);
17	socket.close();
18});