eig

eightylegs

Simplified api wrapper for 80legs api

Showing:

Popularity

Downloads/wk

0

Maintenance

No Maintenance Data Available

Package

Dependencies

5

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

eightylegs

Simplified api wrapper for 80legs api

Quick Example

var eightyLegs = require('eightylegs')('API_KEY')
  , list       = [ 'www.google.com', 'www.facebook.com' ]
  , name       = 'My first url list'
eightyLegs.createUrlList(name, list, function(err, result) {
  //If create successfully, result will be your url list name (My first url list)
})

var options = {
    app : 'FullPageContent.js' // Default value
  , urllist : name // Should not be empty
  , 'max_depth' : 0 // Default value
  , 'max_urls' : 20 // Default value
}
var crawlName = 'My first crawl'
eightyLegs.createCrawl(options, crawlName, function(err, result) {
    // If create successfully, result will be object that contains exact same property with 80legs default return value.
})

Download

The source is available for download from GitHub.. Alternatively, you can install using Node Package Manager (npm):

npm install eightylegs

Documentation

Init

You can require eighylegs by simpily add your API_KEY as parameter

var eightyLegs = require('eightylegs')('API_KEY')

URL List

Crawl

URL List

### createUrlList(urlListName, urlList, callback)

Create a url list that contains an array of website urls that you want to crawl

Arguments

  • urlListName - The name of url list that you want to create.
  • urlList - An array consists of urls that you want to crawl
  • callback(err, result) - A callback which is fired when create process is finished, if something went wrong, err will not be null and will consists two properties code and message representing related error code and message, please refer to 80legs api doc to see detail.

Example

var eightyLegs = require('eightylegs')('API_KEY')
  , list       = [ 'www.google.com', 'www.facebook.com' ]
  , name       = 'My first url list'
eightyLegs.createUrlList(name, list, function(err, result) {
  //If create successfully, result will be your url list name (My first url list)
})

### getAllUrlLists(callback) Get all url lists that you create

Arguments

  • callback(err, result) - A callback which is fired when get process is finished, if something went wrong, err will not be null and will consists two properties code and message representing related error code and message, please refer to 80legs api doc to see detail.

Example

var eightyLegs = require('eightylegs')('API_KEY')
eightyLegs.getAllUrlLists(function(err, result) {
  //If get successfully, result will be your url lists (Formatted in array)
})

### getUrlListByName(urlListName, callback)

Get a url list that named urlListName

Arguments

  • urlListName - The name of url list that you want to get.
  • callback(err, result) - A callback which is fired when get process is finished, if something went wrong, err will not be null and will consists two properties code and message representing related error code and message, please refer to 80legs api doc to see detail.

Example

var eightyLegs = require('eightylegs')('API_KEY')
  , name       = 'My first url list'
eightyLegs.getUrlListByName(name, function(err, result) {
  //If get successfully, result will be your url list named 'My first url list'
})

### deleteUrlList(urlListName, callback)

Delete a url list that named urlListName

Arguments

  • urlListName - The name of url list that you want to delete.
  • callback(err, result) - A callback which is fired when delete process is finished, if something went wrong, err will not be null and will consists two properties code and message representing related error code and message, please refer to 80legs api doc to see detail.

Example

var eightyLegs = require('eightylegs')('API_KEY')
  , name       = 'My first url list'
eightyLegs.deleteUrlList(name, function(err, result) {
  //If delete succesfully, err will be null and result will be url list name (My first url list)
})

Crawl

### createCrawl(options, crawlName, callback)

Create a crawl that you want to execute named crawlName

Arguments

  • options - The required options to create a crawl in 80legs.
    • app - The web crawl app name that 80legs will use. Default value will be FullPageContent.js
    • urllist - The url list named urllist that you want to crawl. CANNOT BE EMPTY!
    • max_depth - The depth of website you want to crawl. Default value will be 0
    • max_urls - The max urls that this 80legs app will crawl in url list. Default value will be 20
  • crawlName - The name of crawl that you want to create.
  • callback(err, result) - A callback which is fired when create process is finished, if something went wrong, err will not be null and will consists two properties code and message representing related error code and message, please refer to 80legs api doc to see detail.

Example

var eightyLegs = require('eightylegs')('API_KEY')
  , name       = 'My first crawl'
  , option     = {
        app         : 'FullPageContent.js' // Can be omitted
      , urllist     : 'My first url list' // Can not be omitted
      , 'max_depth' : 0 // Can be omitted
      , 'max_urls'  : 20 // Can be omitted
    }
eightyLegs.createCrawl(option, name, function(err, result) {
  //If create succesfully, err will be null and result will be status of crawl you just created
})

### getResultByName(crawlName, callback)

Get a crawl that named crawlName

Arguments

  • crawlName - The name of crawl that you want to get.
  • callback(err, result) - A callback which is fired when get process is finished, if something went wrong, err will not be null and will consists two properties code and message representing related error code and message, please refer to 80legs api doc to see detail.

Example

var eightyLegs = require('eightylegs')('API_KEY')
  , name       = 'My first crawl'

eightyLegs.getResultByName(option, name, function(err, result) {
  //If crawl is not finished yet, the result will be false
  //If crawl is finished, the result will be the array of final crawl results
})

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial