
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
An extensible, asynchronous HTTP reverse proxy and origin server.
Setup the server:
var argo = require('argo');
argo()
.use(function(handle) {
handle('response', function(env, next) {
env.response.setHeader('Access-Control-Allow-Origin', '*');
next(env);
});
})
.target('http://weather.yahooapis.com')
.listen(1337);
Make a request:
$ curl -i http://localhost:1337/forecastrss?w=2467861
HTTP/1.1 200 OK
Date: Thu, 28 Feb 2013 20:55:03 GMT
Content-Type: text/xml;charset=UTF-8
Connection: keep-alive
Server: YTS/1.20.13
Access-Control-Allow-Origin: *
Content-Length: 2337
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<GiantXMLResponse/>
Setup the server:
var argo = require('argo');
argo()
.get('^/dogs$', function(handle) {
handle('request', function(env, next) {
env.response.statusCode = 200;
env.response.body = { dogs: ['Alfred', 'Rover', 'Dino'] };
next(env);
});
})
.listen(1337);
Make a request:
$ curl -i http://localhost:1337/dogs
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 34
Date: Thu, 28 Feb 2013 20:44:46 GMT
Connection: keep-alive
{"dogs":["Alfred","Rover","Dino"]}
$ npm install argo
type
: 'request'
or 'response'
options
: Mostly used for internal purposes. Optional.
callback(env, next)
: A request or response callback. env
is an environment context that is passed to every handler, and next
is a reference to the next function in the pipeline.
When the handler is complete and wishes to pass to the next function in the pipeline, it must call next(env)
.
handleFunction
is used to set up request and response handlers.
argo()
//For every request add 'X-Custom-Header' with value 'Yippee!'
.use(function(handle) {
handle('request', function(env, next) {
env.request.headers['X-Custom-Header'] = 'Yippee!';
next(env);
});
})
### use(package)
Alias for include(package)
.
target
is used for proxying requests to a backend server.
uri
: a string pointing to the target URI.Example:
argo()
.target('http://weather.yahooapis.com')
### route(path, [options], handleFunction)
path
: a regular expression used to match HTTP Request URI path.
options
: an object with a methods
property to filter HTTP methods (e.g., { methods: ['GET','POST'] }
). Optional.
handleFunction
: Same as in use
.
Example:
argo()
.route('^/greeting$', function(handle) {
handle('request', function(env, next) {
env.response.statusCode = 200;
env.response.headers = { 'Content-Type': 'text/plain' };
env.response.body = 'Hello World!';
next(env);
});
})
Method filters built on top of route
. del
and msearch
correspond to
the DELETE and M-SEARCH methods, respectively.
Example:
argo()
.get('^/puppies$', function(handle) {
handle('request', function(env, next) {
env.response.body = JSON.stringify([{name: 'Sparky', breed: 'Fox Terrier' }]);
next(env);
});
})
### map(path, [options], argoSegmentFunction)
map
is used to delegate control to sub-Argo instances based on a request URI path.
path
: a regular expression used to match the HTTP Request URI path.
options
: an object with a methods
property to filter HTTP methods (e.g., { methods: ['GET','POST'] }
). Optional.
argoSegmentFunction
: a function that is passed an instance of argo
for additional setup.
Example:
argo()
.map('^/payments', function(server) {
server
.use(oauth)
.target('http://backend_payment_server');
})
### include(package)
package
: An object that contains a package
property.The package
property is a function that takes an argo instance as a paramter and returns an object that contains a name
and an install
function.
Example:
var superPackage = function(argo) {
return {
name: 'Super Package',
install: function() {
argo
.use(oauth)
.route('^/super$', require('./super'));
}
};
};
argo()
.include({ package: superPackage})
### listen(port)
port
: A port on which the server should listen.Argo allows a special error
handler for capturing state when an uncaught exception occurs.
argo()
.use(function(handle) {
handle('error', function(env, error, next) {
console.log(error.message);
env.response.statusCode = 500;
env.response.body = 'Internal Server Error';
next(env);
process.exit();
});
})
.get('^/$', function(handle) {
handle('request', function(env, next) {
env.response.body = 'Hello World!';
next(env);
});
})
.get('^/explode$', function(handle) {
handle('request', function(env, next) {
setImmediate(function() { throw new Error('Ahoy!'); });
});
})
.listen(3000);
Unlike other named pipelines, there should be only one error handler assigned to an Argo server. It is recommended to exit the process once an error has been handled. This feature uses domains.
See cluster.js
for an example of using error handling to restart workers in a cluster.
Unit tests:
$ npm test
Test Coverage:
$ npm run-script coverage
MIT
FAQs
An extensible, asynchronous HTTP reverse proxy and origin server.
The npm package argo receives a total of 19 weekly downloads. As such, argo popularity was classified as not popular.
We found that argo demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers 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
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.