Package Exports

node-readability

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-readability) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Readability

Turn any web page into a clean view. This module is based on arc90's readability project.

Features

Optimized for more websites.
Support encodings such as GBK and GB2312.
Converts relative urls to absolute for images and links automatically(Thank Guillermo Baigorria & Tom Sutton).

Install

npm install node-readability

Usage

read(html [, options], callback)

Where

html url or html code.
options is an optional options object
callback is the callback to run - callback(error, article)

Example

var read = require('node-readability');

read('http://howtonode.org/really-simple-file-uploads', function(err, article) {
  // The main body of the page.
  console.log(article.content);
  // The title of the page.
  console.log(article.title);

  // The raw HTML code of the page
  console.log(article.html);
  // The document object of the page
  console.log(article.document);
});

NB If the page has been marked with charset other than utf-8, it will be converted automatically. Charsets such as GBK, GB2312 is also supported.

Options

node-readability will pass the options to fetch directly.

Possible option values

maxRedirects how many redirects allowed, defaults to 10
disableRedirects set to true if redirects are not allowed, defaults to false
headers optional header fields, in the form of {'Header-Field':'value'}
maxResponseLength maximum allowed length for the file, the remainder is cut off. Defaults to Infinity
method defaults to GET
payload request body
disableGzip set to false, to disable content gzipping, needed for Node v0.5.9 which has buggy zlib
cookies an array of cookie definitions in the form of ['name=val']
cookieJar for sharing cookies between requests, see below
outputEncoding
disableDecoding set to true to disable automatic charset decoding to utf-8
overrideCharset set input encoding
asyncDnsLoookup use high performance asynchronous DNS resolution based on c-ares instead of a thread pool calling getaddrinfo(3)
timeout set a timeout in ms
agent pass-through http.request agent parameter

article object

content

The article content of the web page. Return false if failed.

title

The article title of the web page. It's may not same to the text in the <title> tag.

html

The original html of the web page.

document

The document of the web page generated by jsdom. You can use it to access the DOM directly(for example, article.document.getElementById('main')).

Contributors

https://github.com/luin/node-readability/graphs/contributors

License

This code is under the Apache License 2.0. http://www.apache.org/licenses/LICENSE-2.0