summaly

Get any web page's summary. Try it out

Installation

$ npm install summaly

Usage

summaly(url[, opts])

Options

Property	Type	Description	Default
followRedirects	boolean	リダイレクトを解決するかどうか	true
plugins	plugin[] (see below)	Custom plugins	null

Plugin

interface IPlugin {
	test: (url: URL.Url) => boolean;
	summarize: (url: URL.Url) => Promise<Summary>;
}

Returns

A Promise of an Object that contains properties below:

Property	Type	Description
description	string	The description of そのWebページ
icon	string	The url of the icon of そのWebページ
sitename	string	The name of そのWebサイト
thumbnail	string	The url of the thumbnail of そのWebページ
title	string	The title of そのWebページ
url	string	The url of そのWebページ

Example

import summaly from 'summaly';

const summary = await summaly('http://elephant.2chblog.jp/archives/52025138.html');

console.log(summary); // will be ... ↓
/*
{
	title: 'モバＰ「ありすと言えばお漏らし。お漏らしと言えばありす」',
	icon: 'http://livedoor.blogimg.jp/tmg24news/imgs/9/5/favicon.ico',
	description: '1：以下、名無しにかわりましてVIPがお送りします：2013/03/30(土) 14:57:29.09 ID:An34eOmY0モバＰ「反論が あるやつもいるかもしれない」    モバＰ「だが俺の主張も聞いてほしい！　お漏らしさせるならありすが一番だ！」    日菜子「むふふ……いきなりそんなことを大声で',
	thumbnail: 'http://livedoor.blogimg.jp/tmg24news/imgs/8/d/8df6e1a0-s.jpg',
	sitename: 'エレファント速報：SSまとめブログ',
	url: 'http://elephant.2chblog.jp/archives/52025138.html'
}
*/

Testing

npm run test

License

MIT