Big news!Introducing Socket AI - ChatGPT-Powered Threat Analysis.Learn more
Socket
Socket

agent-base

Package Overview
Dependencies
1
Maintainers
1
Versions
27
Issues
File Explorer

Advanced tools

agent-base

Turn a function into an `http.Agent` instance

    7.1.0latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
39,895,887
increased by10.8%

Weekly downloads

Readme

Source

agent-base

Turn a function into an http.Agent instance

This module is a thin wrapper around the base http.Agent class.

It provides an abstract class that must define a connect() function, which is responsible for creating the underlying socket that the HTTP client requests will use.

The connect() function may return an arbitrary Duplex stream, or another http.Agent instance to delegate the request to, and may be asynchronous (by defining an async function).

Instances of this agent can be used with the http and https modules. To differentiate, the options parameter in the connect() function includes a secureEndpoint property, which can be checked to determine what type of socket should be returned.

Some subclasses:

Here are some more interesting uses of agent-base. Send a pull request to list yours!

  • http-proxy-agent: An HTTP(s) proxy http.Agent implementation for HTTP endpoints
  • https-proxy-agent: An HTTP(s) proxy http.Agent implementation for HTTPS endpoints
  • pac-proxy-agent: A PAC file proxy http.Agent implementation for HTTP and HTTPS
  • socks-proxy-agent: A SOCKS proxy http.Agent implementation for HTTP and HTTPS

Example

Here's a minimal example that creates a new net.Socket or tls.Socket based on the secureEndpoint property. This agent can be used with both the http and https modules.

import * as net from 'net'; import * as tls from 'tls'; import * as http from 'http'; import { Agent } from 'agent-base'; class MyAgent extends Agent { connect(req, opts) { // `secureEndpoint` is true when using the "https" module if (opts.secureEndpoint) { return tls.connect(opts); } else { return net.connect(opts); } } }); // Keep alive enabled means that `connect()` will only be // invoked when a new connection needs to be created const agent = new MyAgent({ keepAlive: true }); // Pass the `agent` option when creating the HTTP request http.get('http://nodejs.org/api/', { agent }, (res) => { console.log('"response" event!', res.headers); res.pipe(process.stdout); });

License

(The MIT License)

Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Keywords

FAQs

Last updated on 24 May 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
Socket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc