mirror of
https://github.com/misskey-dev/summaly.git
synced 2025-05-18 12:07:17 +09:00
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
summaly
|
||
=======
|
||
|
||
[![][npm-badge]][npm-link]
|
||
|
||
Get any web page's summary.
|
||
|
||
Installation
|
||
------------
|
||
`$ npm install summaly`
|
||
|
||
Usage
|
||
-----
|
||
```
|
||
(url: string) => Promise<{
|
||
title: string;
|
||
icon: string;
|
||
description: string;
|
||
thumbnail: string;
|
||
sitename: string;
|
||
}>
|
||
```
|
||
|
||
### Example
|
||
``` javascript
|
||
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まとめブログ'
|
||
}
|
||
*/
|
||
```
|
||
|
||
License
|
||
-------
|
||
[MIT](LICENSE)
|
||
|
||
[npm-link]: https://www.npmjs.com/package/summaly
|
||
[npm-badge]: https://img.shields.io/npm/v/summaly.svg?style=flat-square
|