keyword-miner

0.4.3 • Public • Published

keyword miner

Extract a list of keywords from a website, sorted by word count. Uses text-miner and cheerio for HTML/text parsing.

Top 10 keywords for https://en.wikipedia.org/wiki/Data_mining:

Example data

Usage

$ npm install keyword-miner
/**
 * keyword-miner exports a function with the following params:
 * @param {String|Object} url string or options object
 * @param {Function} done 
 **/
var miner = require('keyword-miner');
 
var options = {
  site: 'https://en.wikipedia.org/wiki/Data_mining',
 
  // only include words with at least n occurences, default 0 (no threshold)
  threshold: 5,
 
  // limit output count, default 0 (no limit)
  limit: 20,
 
  // css element(s) to get keywords from, default 'body'
  element: 'body',
 
  // exclude keywords, default []
  exclude: []
};
 
// call function and print results when done
miner(
  options,
  (error, words) => {
    if (error)
      throw error;
 
    console.log('words:', words);
  }
);

Readme

Keywords

none

Package Sidebar

Install

npm i keyword-miner

Weekly Downloads

5

Version

0.4.3

License

MIT

Last publish

Collaborators

  • mateogianolio