vless-proxy-agent

A VLESS proxy http.Agent implementation for HTTP and HTTPS requests.

This package provides an http.Agent implementation that connects to a VLESS proxy server for HTTP and HTTPS requests.

Installation

npm install vless-proxy-agent

Usage

import { VlessProxyAgent } from 'vless-proxy-agent';
import https from 'https';

const proxy = 'vless://uuid@host:port?security=reality&sni=example.com&type=tcp&encryption=none';
const agent = new VlessProxyAgent(proxy);

https.get('https://example.com', { agent }, (res) => {
  console.log('"response" event!', res.headers);
  res.pipe(process.stdout);
});

API

new VlessProxyAgent(proxy[, options])

• proxy {String|URL} - VLESS proxy URL
• options {Object} - Optional options object with standard http.Agent properties

The VLESS proxy URL should follow this format:

vless://uuid@host:port?security=reality&sni=example.com&type=tcp&encryption=none

Supported URL parameters:

• security: reality, tls, or none
• sni: Server Name Indication for TLS
• type: tcp, ws, or grpc (currently only TCP is supported)
• encryption: none or auto
• fp: Fingerprint for Reality security
• pbk: Public key for Reality security
• sid: Short ID for Reality security
• spx: Spider X for Reality security

License

MIT