misskey-dev/summaly
1
0
Fork 0
mirror of https://github.com/misskey-dev/summaly.git synced 2025-08-07 00:33:59 +09:00
Code Issues Packages Projects Releases Wiki Activity

#16

Browse Source
This commit is contained in:
syuilo
2017-02-04 15:57:02 +09:00
parent 382e963732
commit 2a09c6c1cb
3 changed files with 36 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -1,5 +1,6 @@
unreleased unreleased
------------------ ------------------
* Add `followRedirects` option #16
* Add `url` property to result #15 * Add `url` property to result #15
1.5.0 / 2017-01-31 1.5.0 / 2017-01-31

28
README.md
View File

@ -11,15 +11,24 @@ Installation
Usage Usage
----- -----
``` javascript
summaly(url[, opts])
``` ```
(url: string) => Promise<{
title: string; ### Options
icon: string; | Property | Type | Description | Default |
description: string; | :------------------ | :-------- | :-------------------------- | :------ |
thumbnail: string; | **followRedirects** | *boolean* | リダイレクトを解決するかどうか | `true` |
sitename: string;
}> ### Returns
``` | 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 ### Example
``` javascript ``` javascript
@ -34,7 +43,8 @@ console.log(summary); // will be ... ↓
icon: 'http://livedoor.blogimg.jp/tmg24news/imgs/9/5/favicon.ico', icon: 'http://livedoor.blogimg.jp/tmg24news/imgs/9/5/favicon.ico',
description: '1：以下、名無しにかわりましてVIPがお送りします：2013/03/30(土) 14:57:29.09 ID:An34eOmY0モバＰ「反論が あるやつもいるかもしれない」 モバＰ「だが俺の主張も聞いてほしい！　お漏らしさせるならありすが一番だ！」 日菜子「むふふ……いきなりそんなことを大声で', description: '1：以下、名無しにかわりましてVIPがお送りします：2013/03/30(土) 14:57:29.09 ID:An34eOmY0モバＰ「反論が あるやつもいるかもしれない」 モバＰ「だが俺の主張も聞いてほしい！　お漏らしさせるならありすが一番だ！」 日菜子「むふふ……いきなりそんなことを大声で',
thumbnail: 'http://livedoor.blogimg.jp/tmg24news/imgs/8/d/8df6e1a0-s.jpg', thumbnail: 'http://livedoor.blogimg.jp/tmg24news/imgs/8/d/8df6e1a0-s.jpg',
sitename: 'エレファント速報：SSまとめブログ' sitename: 'エレファント速報：SSまとめブログ',
url: 'http://elephant.2chblog.jp/archives/52025138.html'
} }
*/ */
``` ```

20
src/index.ts
View File

@ -14,14 +14,26 @@ const plugins: IPlugin[] = require('require-all')({
dirname: __dirname + '/plugins' dirname: __dirname + '/plugins'
}); });
export interface IOptions {
/**
* リダイレクトを追跡するか否か
*/
followRedirects: boolean;
}
/** /**
* Summary an web page * Summary an web page
* @param {string} url URL of web page you want to summary * @param {string} url URL of web page you want to summary
* @return {Promise<ISummary>} Promised summary * @param {IOptions} options The options
* @return {Promise<ISummary>} Promised summary
*/ */
export default async (url: string): Promise<ISummary> => { export default async (url: string, options: IOptions): Promise<ISummary> => {
const opts = Object.assign({
followRedirects: true
}, options);
// Follow redirects // Follow redirects
const actualUrl = await tracer(url); const actualUrl = opts.followRedirects ? await tracer(url) : url;
const _url = URL.parse(actualUrl, true); const _url = URL.parse(actualUrl, true);