Skip to content

Latest commit

 

History

History
89 lines (73 loc) · 3.69 KB

README.md

File metadata and controls

89 lines (73 loc) · 3.69 KB
Raw

summaly

Greenkeeper badge

NPM

Get any web page's summary. Try it out

Installation

$ npm install summaly

Usage

summaly(url[, opts])

Options

Property Type Description Default
followRedirects boolean Whether follow redirects 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 the web page
icon string The url of the icon of the web page
sitename string The name of the web site
thumbnail string The url of the thumbnail of the web page
player string The url of the player of the web page
title string The title of the web page
url string The url of the web page

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',
	player: null
	sitename: 'エレファント速報：SSまとめブログ',
	url: 'http://elephant.2chblog.jp/archives/52025138.html'
}
*/

Testing

npm run test

License

MIT