agent-base
Advanced tools
Package description
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.
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;The http-proxy-agent package provides an HTTP Agent implementation that connects to a specified HTTP proxy server. It is similar to agent-base in that it allows you to customize the behavior of HTTP requests, but it is specifically designed for proxying.
Similar to http-proxy-agent, https-proxy-agent is an HTTPS Agent implementation for proxying HTTPS requests. It provides similar functionality to agent-base but is tailored for HTTPS connections through a proxy server.
The socks-proxy-agent package is an HTTP Agent that connects to a SOCKS proxy server. It is another example of a package that extends the functionality of the core HTTP Agent, similar to agent-base, but with a focus on SOCKS proxy support.
Readme
http.Agent implementationThis module provides a very basic, barebones implementation of a Node.js
http.Agent. This can be used with the built-in http module.
It provides no Keep-Alive support and no socket pooling. It's very minimal.
It's minimal in order to be easily extended, and to feel like I have a sense of
"control" over the underlying sockets being used by the http module.
This also allows for cooler things to be done in subclasses, like preprocessing the socket somehow, or perhaps connecting the socket to a different server entirely (think proxy servers).
Here's some more interesting subclasses of agent-base. Send a pull request to
add yours!
http-proxy-agent: An HTTP(s) proxy http.Agent implementation for HTTP endpointshttps-proxy-agent: An HTTP(s) proxy http.Agent implementation for HTTPS endpointsInstall with npm:
$ npm install agent-base
var url = require('url');
var http = require('http');
var Agent = require('agent-base');
var endpoint = 'http://nodejs.org/api/';
var opts = url.parse(endpoint);
// This is the important part!
opts.agent = new Agent();
// Everything else works just like normal...
http.get(opts, function (res) {
console.log('"response" event!', res.headers);
res.pipe(process.stdout);
});
(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.
FAQs
Turn a function into an `http.Agent` instance
The npm package agent-base receives a total of 51,480,312 weekly downloads. As such, agent-base popularity was classified as popular.
We found that agent-base demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.
Security News
NIST updates on the NVD backlog after media reports that over 50% of KEVs were unenriched since mid-February. They've contracted additional support and partnered with CISA to clear the backlog by fiscal year-end.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.