/usr/share/doc/node-get/README.md is in node-get 1.1.5+ds1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | # get [](http://travis-ci.org/developmentseed/node-get)
`get` is a slightly higher-level HTTP client for nodejs.
## Installation
npm install get
get has no dependencies.
For testing, you'll need make and [expresso](https://github.com/visionmedia/expresso).
For docs you'll need [docco](https://github.com/jashkenas/docco).
## Features
* Redirect following.
* Convenience functions for downloading and getting data as string.
* Binary-extension and basic binary detection.
* Configurable headers
## API
Downloads are objects in `get`.
```javascript
var dl = new get({ uri: 'http://google.com/' });
```
The get constructor can also take a plain string if you don't want to give options.
```javascript
var dl = new get('http://google.com/');
```
It can also take other options.
```javascript
var dl = new get({
uri: 'http://google.com/',
max_redirs: 20,
});
```
Then it exposes three main methods
```javascript
dl.asString(function(err, str) {
console.log(str);
});
```
and
```javascript
dl.toDisk('myfile.txt', function(err, filename) {
console.log(err);
});
```
and finally
```javascript
dl.asBuffer(function(err, data) {
console.log(data);
});
```
There's also a lower-level API.
```javascript
dl.perform(function(err, response) {
// response is just a response object, just like
// HTTP request, except handling redirects
});
```
If you give node-get an object of settings instead of a string,
it accepts
* `uri` - the address of the resource
* `headers` - to replace its default headers with custom ones
* `max_redirs` - the number of redirects to follow before returning an error
* `no_proxy` - don't use a HTTP proxy, even if one is in `ENV`
* `encoding` - When calling `.guessEncoding()`, `get` will use this instead of the default value
## Example
```
var get = require('get');
new get('http://google.com/').asString(function(err, data) {
if (err) throw err;
console.log(data);
});
```
## TODO:
* Guessing encoding wth headers
* User-customizable encodings
## Authors
* Tom MacWright (tmcw)
* Konstantin Kaefer (kkaefer)
|