summaryrefslogtreecommitdiff
path: root/node_modules/follow-redirects/README.md
diff options
context:
space:
mode:
authorJeffrey Burdges <burdges@gnunet.org>2017-08-29 13:41:58 +0200
committerJeffrey Burdges <burdges@gnunet.org>2017-08-29 13:41:58 +0200
commit541256ca99875b6007cf6338f7593c8397053514 (patch)
tree662ca2ee4d1846401bdc826895ad7a8390d54f9a /node_modules/follow-redirects/README.md
parent33edef30acda54fc23ec1238d8de13c07a0c87a8 (diff)
parent52ebba90d6625f78105b94fb4f528bca829cb18f (diff)
downloadwallet-core-541256ca99875b6007cf6338f7593c8397053514.tar.gz
wallet-core-541256ca99875b6007cf6338f7593c8397053514.tar.bz2
wallet-core-541256ca99875b6007cf6338f7593c8397053514.zip
Merge branch 'master' of ssh://taler.net/wallet-webex
Diffstat (limited to 'node_modules/follow-redirects/README.md')
-rw-r--r--node_modules/follow-redirects/README.md135
1 files changed, 135 insertions, 0 deletions
diff --git a/node_modules/follow-redirects/README.md b/node_modules/follow-redirects/README.md
new file mode 100644
index 000000000..3851dca89
--- /dev/null
+++ b/node_modules/follow-redirects/README.md
@@ -0,0 +1,135 @@
+## Follow Redirects
+
+Drop-in replacement for Nodes `http` and `https` that automatically follows redirects.
+
+[![npm version](https://badge.fury.io/js/follow-redirects.svg)](https://www.npmjs.com/package/follow-redirects)
+[![Build Status](https://travis-ci.org/olalonde/follow-redirects.svg?branch=master)](https://travis-ci.org/olalonde/follow-redirects)
+[![Coverage Status](https://coveralls.io/repos/olalonde/follow-redirects/badge.svg?branch=master)](https://coveralls.io/r/olalonde/follow-redirects?branch=master)
+[![Code Climate](https://codeclimate.com/github/olalonde/follow-redirects/badges/gpa.svg)](https://codeclimate.com/github/olalonde/follow-redirects)
+[![Dependency Status](https://david-dm.org/olalonde/follow-redirects.svg)](https://david-dm.org/olalonde/follow-redirects)
+[![devDependency Status](https://david-dm.org/olalonde/follow-redirects/dev-status.svg)](https://david-dm.org/olalonde/follow-redirects#info=devDependencies)
+
+[![NPM](https://nodei.co/npm/follow-redirects.png?downloads=true)](https://nodei.co/npm/follow-redirects/)
+
+`follow-redirects` provides [request](https://nodejs.org/api/http.html#http_http_request_options_callback) and [get](https://nodejs.org/api/http.html#http_http_get_options_callback)
+ methods that behave identically to those found on the native [http](https://nodejs.org/api/http.html#http_http_request_options_callback) and [https](https://nodejs.org/api/https.html#https_https_request_options_callback)
+ modules, with the exception that they will seamlessly follow redirects.
+
+```javascript
+var http = require('follow-redirects').http;
+var https = require('follow-redirects').https;
+
+http.get('http://bit.ly/900913', function (response) {
+ response.on('data', function (chunk) {
+ console.log(chunk);
+ });
+}).on('error', function (err) {
+ console.error(err);
+});
+```
+
+You can inspect the final redirected URL through the `responseUrl` property on the `response`.
+If no redirection happened, `responseUrl` is the original request URL.
+
+```javascript
+https.request({
+ host: 'bitly.com',
+ path: '/UHfDGO',
+}, function (response) {
+ console.log(response.responseUrl);
+ // 'http://duckduckgo.com/robots.txt'
+});
+```
+
+## Options
+### Global options
+Global options are set directly on the `follow-redirects` module:
+
+```javascript
+var followRedirects = require('follow-redirects');
+followRedirects.maxRedirects = 10;
+```
+
+The following global options are supported:
+
+- `maxRedirects` (default: `21`) – sets the maximum number of allowed redirects; if exceeded, an error will be emitted.
+
+
+### Per-request options
+Per-request options are set by passing an `options` object:
+
+```javascript
+var url = require('url');
+var followRedirects = require('follow-redirects');
+
+var options = url.parse('http://bit.ly/900913');
+options.maxRedirects = 10;
+http.request(options);
+```
+
+In addition to the [standard HTTP](https://nodejs.org/api/http.html#http_http_request_options_callback) and [HTTPS options](https://nodejs.org/api/https.html#https_https_request_options_callback),
+the following per-request options are supported:
+- `followRedirects` (default: `true`) – whether redirects should be followed.
+
+- `maxRedirects` (default: `21`) – sets the maximum number of allowed redirects; if exceeded, an error will be emitted.
+
+- `agents` (default: `undefined`) – sets the `agent` option per protocol, since HTTP and HTTPS use different agents. Example value: `{ http: new http.Agent(), https: new https.Agent() }`
+
+
+## Browserify Usage
+
+Due to the way `XMLHttpRequest` works, the `browserify` versions of `http` and `https` already follow redirects.
+ If you are *only* targeting the browser, then this library has little value for you. If you want to write cross
+ platform code for node and the browser, `follow-redirects` provides a great solution for making the native node
+ modules behave the same as they do in browserified builds in the browser. To avoid bundling unnecessary code
+ you should tell browserify to swap out `follow-redirects` with the standard modules when bundling.
+ To make this easier, you need to change how you require the modules:
+
+```javascript
+var http = require('follow-redirects/http');
+var https = require('follow-redirects/https');
+```
+
+You can then replace `follow-redirects` in your browserify configuration like so:
+
+```javascript
+"browser": {
+ "follow-redirects/http" : "http",
+ "follow-redirects/https" : "https"
+}
+```
+
+The `browserify-http` module has not kept pace with node development, and no long behaves identically to the native
+ module when running in the browser. If you are experiencing problems, you may want to check out
+ [browserify-http-2](https://www.npmjs.com/package/http-browserify-2). It is more actively maintained and
+ attempts to address a few of the shortcomings of `browserify-http`. In that case, your browserify config should
+ look something like this:
+
+```javascript
+"browser": {
+ "follow-redirects/http" : "browserify-http-2/http",
+ "follow-redirects/https" : "browserify-http-2/https"
+}
+```
+
+## Contributing
+
+Pull Requests are always welcome. Please [file an issue](https://github.com/olalonde/follow-redirects/issues)
+ detailing your proposal before you invest your valuable time. Additional features and bug fixes should be accompanied
+ by tests. You can run the test suite locally with a simple `npm test` command.
+
+## Debug Logging
+
+`follow-redirects` uses the excellent [debug](https://www.npmjs.com/package/debug) for logging. To turn on logging
+ set the environment variable `DEBUG=follow-redirects` for debug output from just this module. When running the test
+ suite it is sometimes advantageous to set `DEBUG=*` to see output from the express server as well.
+
+## Authors
+
+- Olivier Lalonde (olalonde@gmail.com)
+- James Talmage (james@talmage.io)
+- [Ruben Verborgh](https://ruben.verborgh.org/)
+
+## License
+
+MIT: [http://olalonde.mit-license.org](http://olalonde.mit-license.org)