The agent-base package is a module for Node.js that allows you to create custom HTTP/HTTPS Agents. It is used to implement custom proxying behavior, connection pooling, and other HTTP client enhancements. It provides a simple way to extend the core `http.Agent` class to customize the behavior of HTTP requests.

What are agent-base's main functionalities?

Custom HTTP Agent

This feature allows you to create a custom HTTP agent by providing a function that handles HTTP requests. The function can perform custom logic and must return a stream, socket, or an existing agent.

const agent = require('agent-base');

function myAgent(request, options) {
  // Custom logic for handling HTTP requests
  return new Promise((resolve, reject) => {
    // Resolve with a custom stream, socket, or an existing agent
    resolve(myCustomStreamOrSocket);
  });
}

module.exports = agent(myAgent);

HTTPS Agent with Custom Certificate

This feature demonstrates how to create an HTTPS agent with a custom certificate. The agent is created by extending the `https.Agent` class and adding custom options, such as SSL key and certificate.

const agent = require('agent-base');
const https = require('https');
const fs = require('fs');

const options = {
  key: fs.readFileSync('key.pem'),
  cert: fs.readFileSync('cert.pem')
};

const httpsAgent = agent((req, opts) => {
  return new Promise((resolve, reject) => {
    opts = Object.assign({}, opts, options);
    resolve(new https.Agent(opts));
  });
});

module.exports = httpsAgent;

Other packages similar to agent-base

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 absract 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's 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)

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

What is agent-base?

Is agent-base popular?

Is agent-base well maintained?

Last updated on 05 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install