misskey-dev/summaly
1
0
Fork 0
mirror of https://github.com/misskey-dev/summaly.git synced 2025-06-05 12:57:23 +09:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
syuilo 2017-02-05 21:22:36 +09:00
parent 135530b947
commit 337945d5bb
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -21,9 +21,18 @@ summaly(url[, opts])
``` ```
### Options ### Options
| Property | Type | Description | Default | | Property | Type | Description | Default |
| :------------------ | :-------- | :-------------------------- | :------ | | :------------------ | :--------------------- | :-------------------------- | :------ |
| **followRedirects** | *boolean* | リダイレクトを解決するかどうか | `true` | | **followRedirects** | *boolean* | リダイレクトを解決するかどうか | `true` |
| **plugins** | *plugin[] (see below)* | Custom plugins | `null` |
#### Plugin
``` typescript
interface IPlugin {
test: (url: URL.Url) => boolean;
summary: (url: URL.Url) => Promise<ISummary>;
}
```
### Returns ### Returns
A Promise of an Object that contains properties below: A Promise of an Object that contains properties below: