Logo for jsDocs.io

socks-proxy-agent

  • Version 10.1.0
  • Published
  • 18 kB
  • 3 dependencies
  • MIT license

Install

npm i socks-proxy-agent
yarn add socks-proxy-agent
pnpm add socks-proxy-agent

Overview

A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS

Index

Classes

Type Aliases

Classes

class SocksProxyAgent

class SocksProxyAgent extends Agent {}

    constructor

    constructor(uri: any, opts?: any);

      property protocols

      static protocols: readonly ['socks', 'socks4', 'socks4a', 'socks5', 'socks5h'];

        property proxy

        readonly proxy: SocksProxy;

          property proxyUrl

          readonly proxyUrl: string;

            property shouldLookup

            readonly shouldLookup: boolean;

              property socketOptions

              socketOptions: SocksSocketOptions;

                property timeout

                timeout: number;

                  method connect

                  connect: (
                      req: http.ClientRequest,
                      opts: AgentConnectOpts
                  ) => Promise<net.Socket>;

                  • Initiates a SOCKS connection to the specified SOCKS proxy server, which in turn connects to the specified remote host and port.

                  Type Aliases

                  type SocksProxyAgentOptions

                  type SocksProxyAgentOptions = Omit<
                      SocksProxy,
                      'ipaddress' | 'host' | 'port' | 'type' | 'userId' | 'password'
                  > & {
                      socketOptions?: SocksSocketOptions;
                  } & http.AgentOptions;

                    Package Files (1)

                    Dependencies (3)

                    Dev Dependencies (12)

                    Peer Dependencies (0)

                    No peer dependencies.

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/socks-proxy-agent.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/socks-proxy-agent)
                    • HTML
                      <a href="https://www.jsdocs.io/package/socks-proxy-agent"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>