0.0.8 • Published 9 years ago
luminati-proxy v0.0.8
Luminati
Kind: global class
- Luminati
- new Luminati(config)
- .getProxy() ⇒ Promise
new Luminati(config)
Luminati!!
Param | Type |
---|---|
config | LuminatiConfig |
luminati.getProxy() ⇒ Promise
getProxy is what you call every time you need a new exit node.
Kind: instance method of Luminati
Returns: Promise - Returns promise that resolves with string to use as proxy in your
net requests.
Note: this promise will perform a DNS lookup the first time it is called, but after
should resolve immediately. This is the entire string used as "host" when
making http requests!
Example
var request = require('request');
var Luminati = require('luminati');
var luminati = new Luminati({
username: 'myusername-zone-myzone',
password: 'mypassword'
});
luminati.getProxy().then(proxy => {
request({ url: 'http://coolurl.com', proxy: proxy })
.pipe(toWherever)
});
LuminatiConfig : Object
Kind: global typedef
Properties
Name | Type | Default | Description |
---|---|---|---|
username | String | luminati username in the form USER-zone-ZONE | |
password | String | luminati password | |
frequency | Number | 60000 | frequency, in ms, that you want to refresh the DNS of the super-proxy you are using. |
superProxyLocation | String | gb | country code to use for super proxy location. |
exitLocation | String | false | country code if you want exit node to be in a specific country. If not provided, will provide exit nodes in random countries. |
dnsResolution | String | local | can be 'local' or 'remote' - where the final url should have its DNS resolved, locally at the super proxy, or remotes at the exit node. |
https | Boolean | false | whether you want to use an https proxy url or not. |