Skip to content

Commit 79d9ead

Browse files
samunohitosamunohito
authored
fix: 次バージョンに向けての記載を追加 (misskey-dev#25)
1 parent c261071 commit 79d9ead

File tree

3 files changed

+37
-23
lines changed

3 files changed

+37
-23
lines changed

‎CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
5.1.0 / 2024-xx-xx
2+
* GETリクエストよりも前にHEADリクエストを送信し、その結果を使用して検証するように (#22)
3+
* 下記のパラメータを`summaly`メソッドのオプションに追加
4+
- userAgent
5+
- responseTimeout
6+
- operationTimeout
7+
- contentLengthLimit
8+
- contentLengthRequired
9+
110
5.0.3 / 2023-12-30
211
------------------
312
* Fix .github/workflows/npm-publish.yml

‎README.md

+27-22
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,17 @@ npm run serve
4343

4444
#### opts (SummalyOptions)
4545

46-
| Property | Type | Description | Default |
47-
| :------------------ | :--------------------- | :------------------------------ | :------ |
48-
| **lang** | *string* | Accept-Language for the request | `null` |
49-
| **followRedirects** | *boolean* | Whether follow redirects | `true` |
50-
| **plugins** | *plugin[]* (see below) | Custom plugins | `null` |
51-
| **agent** | *Got.Agents* | Custom HTTP agent (see below) | `null` |
46+
| Property | Type | Description | Default |
47+
|:--------------------------|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|
48+
| **lang** | *string* | Accept-Language for the request | `null` |
49+
| **followRedirects** | *boolean* | Whether follow redirects | `true` |
50+
| **plugins** | *plugin[]* (see below) | Custom plugins | `null` |
51+
| **agent** | *Got.Agents* | Custom HTTP agent (see below) | `null` |
52+
| **userAgent** | *string* | User-Agent for the request | `SummalyBot/[version]` |
53+
| **responseTimeout** | *number* | Set timeouts for each phase, such as host name resolution and socket communication. | `20000` |
54+
| **operationTimeout** | *number* | Set the timeout from the start to the end of the request. | `60000` |
55+
| **contentLengthLimit** | *number* | If set to true, an error will occur if the content-length value returned from the other server is larger than this parameter (or if the received body size exceeds this parameter). | `10485760` |
56+
| **contentLengthRequired** | *boolean* | If set to true, it will be an error if the other server does not return content-length. | `false` |
5257

5358
#### Plugin
5459

@@ -78,30 +83,30 @@ A Promise of an Object that contains properties below:
7883

7984
#### SummalyResult
8085

81-
| Property | Type | Description |
82-
| :-------------- | :------- | :------------------------------------------ |
83-
| **title** | *string* \| *null* | The title of the web page |
84-
| **icon** | *string* \| *null* | The url of the icon of the web page |
85-
| **description** | *string* \| *null* | The description of the web page |
86-
| **thumbnail** | *string* \| *null* | The url of the thumbnail of the web page |
87-
| **sitename** | *string* \| *null* | The name of the web site |
88-
| **player** | *Player* | The player of the web page |
89-
| **sensitive** | *boolean* | Whether the url is sensitive |
86+
| Property | Type | Description |
87+
|:----------------|:-------------------|:-----------------------------------------------------------|
88+
| **title** | *string* \| *null* | The title of the web page |
89+
| **icon** | *string* \| *null* | The url of the icon of the web page |
90+
| **description** | *string* \| *null* | The description of the web page |
91+
| **thumbnail** | *string* \| *null* | The url of the thumbnail of the web page |
92+
| **sitename** | *string* \| *null* | The name of the web site |
93+
| **player** | *Player* | The player of the web page |
94+
| **sensitive** | *boolean* | Whether the url is sensitive |
9095
| **activityPub** | *string* \| *null* | The url of the ActivityPub representation of that web page |
91-
| **url** | *string* | The url of the web page |
96+
| **url** | *string* | The url of the web page |
9297

9398
#### Summary
9499

95100
`Omit<SummalyResult, "url">`
96101

97102
#### Player
98103

99-
| Property | Type | Description |
100-
| :-------------- | :--------- | :---------------------------------------------- |
101-
| **url** | *string* \| *null* | The url of the player |
102-
| **width** | *number* \| *null* | The width of the player |
103-
| **height** | *number* \| *null* | The height of the player |
104-
| **allow** | *string[]* | The names of the allowed permissions for iframe |
104+
| Property | Type | Description |
105+
|:-----------|:-------------------|:------------------------------------------------|
106+
| **url** | *string* \| *null* | The url of the player |
107+
| **width** | *number* \| *null* | The width of the player |
108+
| **height** | *number* \| *null* | The height of the player |
109+
| **allow** | *string[]* | The names of the allowed permissions for iframe |
105110

106111
Currently the possible items in `allow` are:
107112

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@misskey-dev/summaly",
3-
"version": "5.0.4",
3+
"version": "5.1.0",
44
"description": "Get web page's summary",
55
"author": "syuilo <[email protected]>",
66
"license": "MIT",

0 commit comments

Comments
 (0)