Code Monkey home page Code Monkey logo

node-tinycrawler's Introduction

Tiny web-crawler for Node.js

This is a tiny web crawler under 1000 lines of code.

[![Maintenance Status][status-image]][status-url] [status-image]: https://img.shields.io/badge/status-maintained-brightgreen.svg [status-url]: https://github.com/bfwg/node-tinycrawler

Usage

var Crawler = require('../lib/crawler')
var crawler = new Crawler('http://www.someUrl.com');

// crawler.maxDepth = 4;
// crawler.crawlInterval = 10;
// crawler.maxListenerCurrency = 10;
// crawler.redisQueue = true;
crawler.start();

Lifecycle:

start => fetcherror | timeout => fetchcomplete | fetchredirect => complete

start

crawler.on('start', () => {
    console.log('Start crawling');
})

fetcherror | timeout

crawler.on("fetcherror", (a, b) => {
  console.log(b.statusCode);
});

crawler.on('timeout', () => {
  console.log('timeout');
});

fetchcomplete | fetchredirect

crawler.on('fetchredirect', (queueItem, targetl) => {
  console.log('REDIRECTED', queueItem.url, 'to', targetl);
});

crawler.on('fetchcomplete', (queueItem, buffer) => {
  // Do whatever you want with queueItem or buffer
  console.log('finished fetching', queueItem.url);
});

More options

maxDepth

The maximum depth crawler allow to go.

crawlInterval

The interval for dispatching crawlers.

maxListenerCurrency

How many crawlers are we dispatching at the same time.

redisQueue

For bigger websides, default in memory queue might not be enough. Install redis first and config tiny-crawler to use redis queue.

This repository is heavily influenced by node-simple-crawler

node-tinycrawler's People

Contributors

bfwg avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

barathkumark

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.