Class PacProxyAgent<Uri>

The PacProxyAgent class.

A few different "protocol" modes are supported (supported protocols are backed by the get-uri module):

  • "pac+data", "data" - refers to an embedded "data:" URI
  • "pac+file", "file" - refers to a local file
  • "pac+ftp", "ftp" - refers to a file located on an FTP server
  • "pac+http", "http" - refers to an HTTP endpoint
  • "pac+https", "https" - refers to an HTTPS endpoint

Type Parameters

  • Uri extends string

Hierarchy

Constructors

constructor

Properties

cache? freeSockets keepAlive maxFreeSockets maxSockets maxTotalSockets options opts requests resolver? resolverHash resolverPromise? sockets uri captureRejectionSymbol captureRejections defaultMaxListeners errorMonitor protocols

Accessors

defaultPort protocol

Methods

addListener clearResolverPromise connect createConnection createSocket destroy emit eventNames getMaxListeners getResolver isSecureEndpoint listenerCount listeners loadPacFile loadResolver off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners listenerCount on once

Constructors

constructor

Properties

Optional cache

cache?: Readable

Readonly freeSockets

freeSockets: ReadOnlyDict<Socket[]>

keepAlive

keepAlive: boolean

maxFreeSockets

maxFreeSockets: number

maxSockets

maxSockets: number

maxTotalSockets

maxTotalSockets: number

options

options: Partial<TcpNetConnectOpts & ConnectionOptions>

opts

opts: PacProxyAgentOptions<Uri>

Readonly requests

requests: ReadOnlyDict<IncomingMessage[]>

Optional resolver

resolver?: ((url, _host?) => Promise<string>)

Type declaration

    • (url, _host?): Promise<string>

    • Returns an asynchronous FindProxyForURL() function from the given JS string (from a PAC file).

      Parameters

      • url: string | URL
      • Optional _host: string

      Returns Promise<string>

resolverHash

resolverHash: string

Optional resolverPromise

resolverPromise?: Promise<((url, _host?) => Promise<string>)>

Type declaration

    • (url, _host?): Promise<string>

    • Returns an asynchronous FindProxyForURL() function from the given JS string (from a PAC file).

      Parameters

      • url: string | URL
      • Optional _host: string

      Returns Promise<string>

Readonly sockets

sockets: ReadOnlyDict<Socket[]>

uri

uri: URL

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.

Static Readonly protocols

protocols: ("pac+data" | "pac+file" | "pac+ftp" | "pac+http" | "pac+https")[] = ...

Accessors

defaultPort

  • get defaultPort(): number

  • Returns number

  • set defaultPort(v): void

  • Parameters

    • v: number

    Returns void

protocol

  • get protocol(): string

  • Returns string

  • set protocol(v): void

  • Parameters

    • v: string

    Returns void

Methods

addListener

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

Private clearResolverPromise

  • Returns void

connect

  • Called when the node-core HTTP client library is creating a new HTTP request.

    Parameters

    Returns Promise<Agent | Socket>

createConnection

  • Returns Duplex

createSocket

  • Parameters

    • req: ClientRequest
    • options: AgentConnectOpts
    • cb: ((err, s?) => void)
        • (err, s?): void

        • Parameters

          • err: null | Error
          • Optional s: Duplex

          Returns void

    Returns void

destroy

  • 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

emit

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • Returns (string | symbol)[]

getMaxListeners

  • Returns number

Private getResolver

  • Loads the PAC proxy file from the source if necessary, and returns a generated FindProxyForURL() resolver function to use.

    Returns Promise<((url, _host?) => Promise<string>)>

    Api

    private

isSecureEndpoint

  • Determine whether this is an http or https request.

    Parameters

    Returns boolean

listenerCount

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • Parameters

    • event: string | symbol

    Returns Function[]

Private loadPacFile

  • Loads the contents of the PAC proxy file.

    Returns Promise<string>

    Api

    private

Private loadResolver

  • Returns Promise<((url, _host?) => Promise<string>)>

off

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

on

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

once

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

prependListener

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

prependOnceListener

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

rawListeners

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns PacProxyAgent<Uri>

removeListener

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PacProxyAgent<Uri>

setMaxListeners

Static listenerCount

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

    Deprecated

    since v4.0.0

Static on

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc