Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

article-parser

2.4.0 • Public • Published

article-parser

Extract main article, main image and meta data from URL.

NPM Build Status

Usage

npm install article-parser

Then:

const {
  extract 
= require('article-parser');
 
let url = 'https://goo.gl/MV8Tkh';
 
extract(url).then((article) => {
  console.log(article);
}).catch((err) => {
  console.log(err);
});

APIs

configure(Object conf)

{
  fetchOptions: Object,
  wordsPerMinute: Number,
  htmlRules: Object,
  SoundCloudKey: String,
  YouTubeKey: String,
  EmbedlyKey: String
}
  • fetchOptions: Object, simple version of node-fetch options. Only headers, timeout and agent are available here.
  • wordsPerMinute: Number, default 300, use to estimate time to read
  • htmlRules: Object, options to to clean HTML with sanitize-html
  • SoundCloudKey: String, use to get audio duration. Get it here.
  • YouTubeKey: String, use to get video duration. Get it here.
  • EmbedlyKey: String, use to extract with Embedly API. Refer here.

Default configurations may work for most case.

extract(String url)

Extract article data from specified url.

const {
  extract 
= require('article-parser');
 
let url = 'https://www.youtube.com/watch?v=tRGJj59G1x4';
 
extract(url).then((article) => {
  console.log(article);
}).catch((err) => {
  console.log(err);
});

Now article would be something like this:

{
  title: 'Zato ESB - Test demo hosted on company server',
  alias: 'zato-esb-test-demo-hosted-on-company-server-1500021746537-PAQXw8IYcU',
  url: 'https://www.youtube.com/watch?v=tRGJj59G1x4',
  canonicals:
   [ 'https://www.youtube.com/watch?v=tRGJj59G1x4',
     'https://youtu.be/tRGJj59G1x4',
     'https://www.youtube.com/v/tRGJj59G1x4',
     'https://www.youtube.com/embed/tRGJj59G1x4' ],
  description: 'Our sample: https://github.com/greenglobal/zato-demo Zato homepage: https://zato.io Tutorial: "Zato — a powerful Python-based ESB solution for your SOA" http...',
  content: '<iframe src="https://www.youtube.com/embed/tRGJj59G1x4?feature=oembed" frameborder="0" allowfullscreen></iframe>',
  image: 'https://i.ytimg.com/vi/tRGJj59G1x4/hqdefault.jpg',
  author: 'Dong Nguyen',
  source: 'YouTube',
  domain: 'youtube.com',
  publishedTime: '',
  duration: 292
}
 

extractWithEmbedly(String url [, String EmbedlyKey])

Extract article data from specified url using Embedly Extract API:

The second parameter is optional. If you've added your Embedly key via configure() method, you can ignore it here.

const {
  extractWithEmbedly 
= require('article-parser');
 
let url = 'https://goo.gl/MV8Tkh';
 
extractWithEmbedly(url).then((article) => {
  console.log(article);
}).catch((err) => {
  console.log(err);
});

getConfig()

Return the current configurations.

Test

git clone https://github.com/ndaidong/article-parser.git
cd article-parser
npm install
npm test

License

The MIT License (MIT)

install

npm i article-parser

Downloadsweekly downloads

346

version

2.4.0

license

MIT

repository

Gitgitlab

last publish

collaborators

  • avatar
Report a vulnerability