createProxyAgent()

SIP Protocol API Reference v0.7.4

---

SIP Protocol API Reference / createProxyAgent

Function: createProxyAgent()

createProxyAgent(config, options?): Promise<Agent | undefined>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:16941

Create a proxy agent for HTTP requests

Note: This requires optional dependencies:

• socks-proxy-agent for SOCKS4/5 proxies
• https-proxy-agent for HTTP/HTTPS proxies

Install with: npm install socks-proxy-agent https-proxy-agent

Parameters

config

ProxyConfig

Proxy configuration

options?

ProxyAgentOptions

Agent options

Returns

Promise<Agent | undefined>

HTTP Agent configured for proxy, or undefined for direct connection

Throws

Error if proxy dependencies not installed

Example

// Using Tor
const agent = await createProxyAgent('tor')

// Using custom SOCKS5
const agent = await createProxyAgent('socks5://127.0.0.1:1080')

// Use with fetch
fetch(url, { agent })