Skip to content

SzymonLisowiec/scrapie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

scrapie

Simple and light framework to scraping data.

Installation

npm i --save scrapie

Examples

Look here

List

const ListScrapper = require('scrapie').List;

let scrapper = new ListScrapper(options);

Options

  • url - url to scraping data
  • delay - delay before next request (ms)
  • request - request/request if you need custom headers etc.

Methods

Basic methods

  • setProgress(fn) - set function to show progress (look example)
  • setNextPage(fn) - set function to specify a next page url, returns false if end of scraping. (look example)
  • setParaser(fn) - set function to parse received body. (look example)
  • addModifier(fn) - add function to modify scraped data. (look example)
  • addFilter(fn) - add function to filtering items (return false to reject item).

In each above methods fn is function with one attribute:

  • data - if server's response is json.
  • $ - if server's response is html. That is Cheerio object
  • body - if server's response is none of the above.

Others methods

  • run() - run scraper (can be used synchronically)
  • setOption(option, value) - set option in config after creation instance

Events

data

  • data [array] - scraped data on live

end

  • data [array] - all scraped data

TODO

  • Autodetect type of server's response, without require type from options

License

MIT License

Copyright (c) 2018 Kysune

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases

No releases published

Packages

No packages published