Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

seenreq

1.0.2 • Public • Published

NPM

build status Dependency Status NPM download NPM quality

seenreq

A library to test if a url/request is crawled, usually used in a web crawler. Compatible with request and node-crawler. The 1.x or newer version has quite different APIs and is not compatible with 0.x versions. Please read the upgrade guide document.

Install

$ npm install seenreq

Basic Usage

const seenreq = require('seenreq')
, seen = new seenreq();
 
//url to be normalized
let url = "http://www.GOOGLE.com";
console.log(seen.normalize(url));//{ sign: "GET http://www.google.com/\r\n", options: {} }
 
//request options to be normalized
let option = {
    uri: 'http://www.GOOGLE.com',
    rupdate: false
};
 
console.log(seen.normalize(option));//{sign: "GET http://www.google.com/\r\n", options:{rupdate: false} }
 
seen.initialize().then(()=>{
    seen.exists(url,(e, rst)={
        console.log(rst[0]);//false if ask for a `request` never see
        seen.exists(opt,(e, rst)=>{
            console.log(rst[0]);//true if got same `request`
        });
    });
}).catch(e){
    console.error(e);
};

When you call exists, the module will do normalization itself first and then check if exists.

Use Redis

seenreq stores keys in memory by default, memory usage will soar as number of keys increases. Redis will solve this problem. Because seenreq uses ioredis as redis client, all ioredis' options are recived and supported. You should first install:

npm install seenreq-repo-redis

and then set repo to redis:

const seenreq = require('seenreq')
let seen = new seenreq({
    repo:'redis',// use redis instead of memory
    host:'127.0.0.1', 
    port:6379,
    clearOnQuit:false // clear redis cache or don't when calling dispose(), default true.
});
 
seen.initialize().then(()=>{
    //do stuff...
}).catch(e){
    console.error(e);
}

Use mongodb

It is similar with redis above:

npm install seenreq-repo-mongo
const seenreq = require('seenreq')
let seen = new seenreq({
    repo:'mongo',
    url:'mongodb://xxx/seenreq',
    collection: 'foor'
});

Class:seenreq

Instance of seenreq

seen.initialize(callback)

  • callback(error, argv), error and argv are callback arguments of repo.initialize. If callback is not passed, a promise will be returned, with error as argument when rejected, argv as argument when resolved.

Initialize the repo

seen.normalize(uri|option[,options])

  • uri String, option is Option of request or node-webcrawler
  • options
  • return normalized Object: {sign,options}

seen.exists(uri|option|array[,options],callback)

  • uri|option
  • options
  • callback
    • error: Error, An error instance representing the error during the execution
    • rst: Array, An array representing if exists, e.g. [true, false, true, false, false]

seen.dispose()

dispose resources of repo. If you are using repo other than memory, like Redis you should call dispose to release connection.

Options

  • removeKeys: Array, Ignore specified keys when doing normalization. For instance, there is a ts property in the url like http://www.xxx.com/index?ts=1442382602504 which is timestamp and it should be same whenever you visit.
  • stripFragment: Boolean, Remove the fragment at the end of the URL (Default true).
  • rupdate: Boolean, it is short for repo update. Store in repo so that seenreq can hit the same req next time (Default true).

RoadMap

  • add mysql repo to persist keys to disk.
  • add keys life time management.

install

npm i seenreq

Downloadsweekly downloads

1,183

version

1.0.2

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar