Class ProxyAgent

Uses the appropriate Agent subclass based off of the "proxy" environment variables that are currently set.

An LRU cache is used, to prevent unnecessary creation of proxy http.Agent instances.

Hierarchy

Agent
- ProxyAgent

Constructors

constructor

new ProxyAgent(opts?): ProxyAgent
Parameters
- Optional opts: ProxyAgentOptions
Returns ProxyAgent
Overrides Agent.constructor
- Defined in packages/proxy-agent/src/index.ts:92

Properties

cache

cache: LRUCache<string, Agent> = ...

Cache for Agent instances.

`Optional` connectOpts

connectOpts?: ProxyAgentOptions

`Readonly` freeSockets

freeSockets: ReadOnlyDict<Socket[]>

getProxyForUrl

getProxyForUrl: GetProxyForUrlCallback

httpAgent

httpAgent: Agent

httpsAgent

httpsAgent: Agent

keepAlive

keepAlive: boolean

maxFreeSockets

maxFreeSockets: number

maxSockets

maxSockets: number

maxTotalSockets

maxTotalSockets: number

options

options: Partial<TcpNetConnectOpts & ConnectionOptions>

`Readonly` requests

requests: ReadOnlyDict<IncomingMessage[]>

`Readonly` sockets

sockets: ReadOnlyDict<Socket[]>

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

defaultPort

get defaultPort(): number
Returns number
Inherited from Agent.defaultPort
- Defined in packages/agent-base/dist/index.d.ts:33
set defaultPort(v): void
Parameters
- v: number
Returns void
Inherited from Agent.defaultPort
- Defined in packages/agent-base/dist/index.d.ts:34

protocol

get protocol(): string
Returns string
Inherited from Agent.protocol
- Defined in packages/agent-base/dist/index.d.ts:35
set protocol(v): void
Parameters
- v: string
Returns void
Inherited from Agent.protocol
- Defined in packages/agent-base/dist/index.d.ts:36

Methods

addListener

addListener(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.addListener
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:57

connect

connect(req, opts): Promise<Agent>
Parameters
- req: ClientRequest
- opts: AgentConnectOpts
Returns Promise<Agent>
Overrides Agent.connect
- Defined in packages/proxy-agent/src/index.ts:102

createConnection

createConnection(): Duplex
Returns Duplex
Inherited from Agent.createConnection
- Defined in packages/agent-base/dist/index.d.ts:32

createSocket

createSocket(req, options, cb): void
Parameters
- req: ClientRequest
- options: AgentConnectOpts
- cb: ((err, s?) => void)
  - - (err, s?): void
    - Parameters
      
      err: null | Error
      
      Optional s: Duplex
      
      Returns void
Returns void
Inherited from Agent.createSocket
- Defined in packages/agent-base/dist/index.d.ts:31

destroy

destroy(): void
Destroy any sockets that are currently in use by the agent. It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

Returns void
Overrides Agent.destroy
- Defined in packages/proxy-agent/src/index.ts:148

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from Agent.emit
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:67

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from Agent.eventNames
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:72

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Agent.getMaxListeners
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:64

isSecureEndpoint

isSecureEndpoint(options?): boolean
Determine whether this is an http or https request.
Parameters
- Optional options: AgentConnectOpts
Returns boolean
Inherited from Agent.isSecureEndpoint
- Defined in packages/agent-base/dist/index.d.ts:30

listenerCount

listenerCount(event): number
Parameters
- event: string | symbol
Returns number
Inherited from Agent.listenerCount
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:68

listeners

listeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from Agent.listeners
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:65

off

off(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.off
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:61

on

on(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.on
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:58

once

once(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.once
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:59

prependListener

prependListener(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.prependListener
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:70

prependOnceListener

prependOnceListener(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.prependOnceListener
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:71

rawListeners

rawListeners(event): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from Agent.rawListeners
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:66

removeAllListeners

removeAllListeners(event?): ProxyAgent
Parameters
- Optional event: string | symbol
Returns ProxyAgent
Inherited from Agent.removeAllListeners
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:62

removeListener

removeListener(event, listener): ProxyAgent
Parameters
- event: string | symbol
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns ProxyAgent
Inherited from Agent.removeListener
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:60

setMaxListeners

setMaxListeners(n): ProxyAgent
Parameters
- n: number
Returns ProxyAgent
Inherited from Agent.setMaxListeners
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:63

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Deprecated
since v4.0.0
Inherited from Agent.listenerCount
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from Agent.on
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Agent.once
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from Agent.once
- Defined in node_modules/.pnpm/@types+node@14.18.45/node_modules/@types/node/events.d.ts:22

Class ProxyAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional opts: ProxyAgentOptions

Returns ProxyAgent

Properties

cache

Optional connectOpts

Readonly freeSockets

getProxyForUrl

httpAgent

httpsAgent

keepAlive

maxFreeSockets

maxSockets

maxTotalSockets

options

Readonly requests

Readonly sockets

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

defaultPort

Returns number

Parameters

v: number

Returns void

protocol

Returns string

Parameters

v: string

Returns void

Methods

addListener

Parameters

event: string | symbol

listener: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns ProxyAgent

connect

Parameters

req: ClientRequest

opts: AgentConnectOpts

Returns Promise<Agent>

createConnection

Returns Duplex

createSocket

Parameters

req: ClientRequest

options: AgentConnectOpts

cb: ((err, s?) => void)

Parameters

err: null | Error

Optional s: Duplex

Returns void

Returns void

destroy

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

isSecureEndpoint

Parameters

`Optional` opts: ProxyAgentOptions

`Optional` connectOpts

`Readonly` freeSockets

`Readonly` requests

`Readonly` sockets

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Optional` s: Duplex

`Rest` ...args: any[]

`Optional` options: AgentConnectOpts

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]