Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on Mar 16, 2024 via pnpm

tunnel-agent 0.6.0

HTTP proxy tunneling agent. Formerly part of mikeal/request, now a standalone module.
Package summary
Share
0
issues
2
licenses
1
MIT
1
Apache-2.0
Package created
1 Mar 2013
Version published
5 Mar 2017
Maintainers
4
Total deps
2
Direct deps
1
License
Apache-2.0

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
safe-buffer@5.2.1

Apache License 2.0

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
use-patent-claims
place-warranty
Cannot
hold-liable
use-trademark
Must
include-copyright
include-license
state-changes
include-notice
1 Packages, Including:
tunnel-agent@0.6.0
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

1
All Dependencies CSV
ⓘ This is a list of tunnel-agent 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
safe-buffer5.2.19.74 kBMIT
prod

Visualizations

Frequently Asked Questions

What does tunnel-agent do?

tunnel-agent is a potent JavaScript library that has its roots in mikeal/request. It is essentially concerned with HTTP proxy tunneling. It means that it assists applications in creating a tunnel to an HTTP proxy, bringing more flexibility and control over network requests. This capability can be incredibly useful in dealing with restricted network access or obscuring the origins of network requests.

How do you use tunnel-agent?

To utilize tunnel-agent, you first need to install the package. It is available on npm, so the installation is as simple as running npm install tunnel-agent in your terminal. Once installed, you can require it in your JavaScript file and use its features. Here is a basic usage example:

var tunnel = require('tunnel-agent');

var agent = tunnel.httpsOverHttp({
  proxy: {
    host: 'localhost',
    port: 8080
  }
});

var options = {
url: 'https://example.com',
agent: agent
};

require('request')(options, function(error, response, body) {
  console.log(body);
});

In this code segment, we first specify the proxy information, including host and port, and then we pass it to the httpsOverHttp method of tunnel-agent. The resultant agent is used in making a request to a specific URL.

Where are the tunnel-agent docs?

The primary source of documentation for tunnel-agent lies within its GitHub repository. Unfortunately, the readme file included in the question does not contain a link to comprehensive documentation. However, developers familiar with JavaScript and HTTP proxies should find ample details within the repository’s code and past revisions. As the module is open-source, one can also sift through the 'Issues' and 'Pull requests' sections to gain an understanding of common queries and updates pertaining to this module. Please visit tunnel-agent's GitHub repository for more details.