readweb v1.1.0

readweb

Use Pareto principle to read the main content of a web page; no need to analyze markups.

Install

npm i readweb

Usage

const readweb = require('readweb');

readweb('https://en.wikipedia.org/wiki/Wikipedia', {
  tags: ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
  paretoRatio: 0.7,
  fetchOptions: {
    highWaterMark: 1024 * 1024
  },
  toTextOptions: {
    selectors: [{ selector: 'img', format: 'skip' }]
  }
})
.then(console.log)
.catch(console.error);

Options:

• selector a cheerio selector, if specified, pareto algorithm will be skipped
• tags an array of html tags to filter elements, e.g. ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6']
• paretoRatio should be less than 1.0 but greater than 0.5. Default: 0.6
• toText whether convert the content to plain text. Default: true
• fetchOptions options fed to fetch. See node-fetch
• toTextOptions options fed to html-to-text. See html-to-text

Major Changes

• Use node-fetch instead of make-fetch-happen;
• Use fetch-cookie to deal with cookies.