Skip to content

Commit f9d4c24

Browse files
coder-hxlcoder-hxl
committed
docs(type): use a table to show the types
1 parent 634f909 commit f9d4c24

File tree

10 files changed

+115
-120
lines changed

10 files changed

+115
-120
lines changed

‎docs/cn/type/crawl-data.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ export interface CrawlDataDetailTargetConfig extends CrawlCommonConfig {
1414
}
1515
```
1616

17-
**默认值**
18-
19-
- url: undefined
20-
- method: 'GET'
21-
- headers: undefined
22-
- params: undefined
23-
- data: undefined
24-
- priority: undefined
25-
- fingerprint: undefined
17+
| 参数 | 类型 | 默认值 | 描述 |
18+
| ----------- | ----------------------------- | ------ | ---------- |
19+
| url | string | - | url |
20+
| method | Method | `GET` | 方法 |
21+
| headers | Object \\| null | - | 请求头 |
22+
| params | IntervalTime | - | Query 参数 |
23+
| data | any | - | 请求体 |
24+
| priority | number | - | 优先级 |
25+
| fingerprint | DetailTargetFingerprintCommon | - | 设备指纹 |
2626

2727
## CrawlDataAdvancedConfig
2828

@@ -40,13 +40,13 @@ export interface CrawlDataAdvancedConfig<T> extends CrawlCommonConfig {
4040
}
4141
```
4242

43-
**默认值**
44-
45-
- targets: undefined
46-
- intervalTime: undefined
47-
- fingerprints: undefined
48-
- headers: undefined
49-
- onCrawlItemComplete: undefined
43+
| 参数 | 类型 | 默认值 | 描述 |
44+
| ------------------- | -------------------------------------------------------- | ------------------------------ | -------- |
45+
| targets | (string \\| CrawlDataDetailTargetConfig)[] | - | 目标 |
46+
| intervalTime | IntervalTime | - | 间隔时间 |
47+
| fingerprints | DetailTargetFingerprintCommon[] | - | 设备指纹 |
48+
| headers | Object | - | 请求头 |
49+
| onCrawlItemComplete | ( crawlDataSingleResult: CrawlDataSingleResult ) => void | - | 声明周期 |
5050

5151
## CrawlDataSingleResult
5252

‎docs/cn/type/crawl-file.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ export interface CrawlFileDetailTargetConfig extends CrawlCommonConfig {
1414
}
1515
```
1616

17-
**默认值**
18-
19-
- url: undefined
20-
- headers: undefined
21-
- priority: undefined
22-
- storeDir: \_\_dirname
23-
- fileName: string
24-
- extension: string
25-
- fingerprint: undefined
17+
| 参数 | 类型 | 默认值 | 描述 |
18+
| ----------- | ----------------------------- | ----------- | -------- |
19+
| url | string | - | url |
20+
| headers | Object \\| null | - | 请求头 |
21+
| priority | number | - | 优先级 |
22+
| storeDir | string | \_\_dirname | 存储位置 |
23+
| fileName | string | - | 文件名 |
24+
| extension | string | - | 扩展名 |
25+
| fingerprint | DetailTargetFingerprintCommon | - | 设备指纹 |
2626

2727
## CrawlFileAdvancedConfig
2828

@@ -47,17 +47,17 @@ export interface CrawlFileAdvancedConfig extends CrawlCommonConfig {
4747
}
4848
```
4949

50-
**默认值**
51-
52-
- targets: undefined
53-
- intervalTime: undefined
54-
- fingerprints: undefined
55-
- storeDirs: \_\_dirname
56-
- extensions: string
57-
- fileNames: undefined
58-
- headers: undefined
59-
- onCrawlItemComplete: undefined
60-
- onBeforeSaveItemFile: undefined
50+
| 参数 | 类型 | 默认值 | 描述 |
51+
| -------------------- | ------------------ | ------------------- | --------- |
52+
| targets | (string \\| CrawlDataDetailTargetConfig)[] | - | 目标 |
53+
| intervalTime | IntervalTime | - | 间隔时间 |
54+
| fingerprints | DetailTargetFingerprintCommon[] | - | 设备指纹 |
55+
| storeDirs | string \\| (string \\| null)[] | \_\_dirname | 存储位置 |
56+
| extension | string \\| (string \\| null)[] | - | 扩展名 |
57+
| fileName | (string \\| null)[] | - | 文件名 |
58+
| headers | Object | - | 请求头 |
59+
| onCrawlItemComplete | ( crawlDataSingleResult: CrawlDataSingleResult ) => void | - | 声明周期 |
60+
| onBeforeSaveItemFile | (info: { id: number; fileName: string; filePath: string; data: Buffer }) => Promise<Buffer \\| void> \\| Buffer \\| void | - | 声明周期 |
6161

6262
## CrawlFileSingleResult
6363

‎docs/cn/type/crawl-html.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ export interface CrawlHTMLDetailTargetConfig extends CrawlCommonConfig {
1111
}
1212
```
1313

14-
**默认值**
15-
16-
- url: undefined
17-
- headers: undefined
18-
- priority: undefined
19-
- fingerprint: undefined
14+
| 参数 | 类型 | 默认值 | 描述 |
15+
| ----------- | ----------------------------- | ------ | -------- |
16+
| url | string | - | url |
17+
| headers | Object \\| null | - | 请求头 |
18+
| priority | number | - | 优先级 |
19+
| fingerprint | DetailTargetFingerprintCommon | - | 设备指纹 |
2020

2121
## CrawlHTMLAdvancedConfig
2222

@@ -32,13 +32,13 @@ export interface CrawlHTMLAdvancedConfig extends CrawlCommonConfig {
3232
}
3333
```
3434

35-
**默认值**
36-
37-
- targets: undefined
38-
- intervalTime: undefined
39-
- fingerprints: undefined
40-
- headers: undefined
41-
- onCrawlItemComplete: undefined
35+
| 参数 | 类型 | 默认值 | 描述 |
36+
| ------------------- | -------------------------------------------------------- | ------------------------------ | -------- |
37+
| targets | (string \\| CrawlDataDetailTargetConfig)[] | - | 目标 |
38+
| intervalTime | IntervalTime | - | 间隔时间 |
39+
| fingerprints | DetailTargetFingerprintCommon[] | - | 设备指纹 |
40+
| headers | Object | - | 请求头 |
41+
| onCrawlItemComplete | ( crawlDataSingleResult: CrawlDataSingleResult ) => void | - | 声明周期 |
4242

4343
## CrawlHTMLSingleResult
4444

‎docs/cn/type/crawl-openai-other-config.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ export interface CrawlOpenAICommonAPIOtherOption {
2525
}
2626
```
2727

28-
- model：要选择的 AI 模型。
29-
30-
**默认值**
31-
32-
- model: undefined
28+
| 参数 | 类型 | 默认值 | 描述 |
29+
| ----- | -- | -- | --- |
30+
| model | 'gpt-4-0125-preview' \\| 'gpt-4-turbo-preview' \\| 'gpt-4-1106-preview' \\| 'gpt-4-vision-preview' \\| 'gpt-4' \\| 'gpt-4-0314' \\| 'gpt-4-0613' \\| 'gpt-4-32k' \\| 'gpt-4-32k-0314' \\| 'gpt-4-32k-0613' \\| 'gpt-3.5-turbo' \\| 'gpt-3.5-turbo-16k' \\| 'gpt-3.5-turbo-0301' \\| 'gpt-3.5-turbo-0613' \\| 'gpt-3.5-turbo-1106' \\| 'gpt-3.5-turbo-0125' \\| 'gpt-3.5-turbo-16k-0613' | - | AI 模型 |

‎docs/cn/type/crawl-page.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ export interface CrawlPageDetailTargetConfig extends CrawlCommonConfig {
2020
}
2121
```
2222

23-
**默认值**
24-
25-
- url: undefined
26-
- headers: undefined
27-
- cookies: undefined
28-
- priority: undefined
29-
- viewport: undefined
30-
- fingerprint: undefined
23+
| 参数 | 类型 | 默认值 | 描述 |
24+
| ----------- | --- | ------ | ------------ |
25+
| url | string | - | url |
26+
| headers | Object \\| null | - | 请求头 |
27+
| cookies | PageCookies \\| null | - | cookies |
28+
| priority | number | - | 优先级 |
29+
| viewport | Viewport | - | 设置视口大小 |
30+
| fingerprint | DetailTargetFingerprintCommon & { maxWidth?: number; minWidth?: number; maxHeight?: number; minHidth?: number }) | - | 设备指纹 |
3131

3232
**外部类型**
3333

@@ -54,15 +54,15 @@ export interface CrawlPageAdvancedConfig extends CrawlCommonConfig {
5454
}
5555
```
5656

57-
**默认值**
58-
59-
- targets: undefined
60-
- intervalTime: undefined
61-
- fingerprints: undefined
62-
- headers: undefined
63-
- cookies: undefined
64-
- viewport: undefined
65-
- onCrawlItemComplete: undefined
57+
| 参数 | 类型 | 默认值 | 描述 |
58+
| ------------------- | -------------------------------------------------------- | ------------------------------ | ------------ |
59+
| targets | (string \\| CrawlDataDetailTargetConfig)[] | - | 目标 |
60+
| intervalTime | IntervalTime | - | 间隔时间 |
61+
| fingerprints | DetailTargetFingerprintCommon[] | - | 设备指纹 |
62+
| headers | Object | - | 请求头 |
63+
| cookies | PageCookies | null | - | cookies |
64+
| viewport | Viewport | - | 设置视口大小 |
65+
| onCrawlItemComplete | ( crawlDataSingleResult: CrawlDataSingleResult ) => void | - | 声明周期 |
6666

6767
**外部类型**
6868

‎docs/cn/type/create-crawl-openai.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ export interface CreateCrawlOpenAIConfig {
1111
}
1212
```
1313

14-
**默认值**
15-
16-
- defaultModel: { chatModel: 'gpt-3.5-turbo' }
17-
- clientOptions: undefined
14+
| 参数 | 类型 | 默认值 | 描述 |
15+
| ------------- | ------------------------------ | ------ | ----------------------------- |
16+
| defaultModel | { chatModel: OpenAIChatModel } | - | AI 模型 |
17+
| clientOptions | ClientOptions | - | AI 其他配置, 用于创建 AI 实例 |
1818

1919
**外部类型**
2020

‎docs/cn/type/get-element-selectors.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ export interface CrawlOpenAIGetElementSelectorsContentOptions {
99
}
1010
```
1111

12-
- pathMode：
13-
- strict：选择器的路径从根部元素开始, 并精确指向目标元素。
14-
- default：可以从任何级别的元素开始的选择器。
15-
16-
**默认值**
17-
18-
- message: undefined
19-
- pathMode: 'default'
12+
| 参数 | 类型 | 默认值 | 描述 |
13+
| -------- | ------------ | -------- | ------------------------------------------------ |
14+
| message | string | - | 你需要 AI 做的操作 |
15+
| pathMode | 'default' \\| 'strict' | 'default' | 类型 |
16+
| | strict | - | 选择器的路径从根部元素开始, 并精确指向目标元素。 |
17+
| | default | - | 可以从任何级别的元素开始的选择器。 |
2018

2119
## CrawlOpenAIGetElementSelectorsResult
2220

@@ -27,8 +25,10 @@ export interface CrawlOpenAIGetElementSelectorsResult {
2725
}
2826
```
2927

30-
- type
31-
32-
- single：说明当前 HTML 片段只找到一个目标。
33-
- multiple： 说明当前 HTML 片段找到多个目标。
34-
- none： 没有在当前 HTML 片段找到。
28+
| 参数 | 类型 | 默认值 | 描述 |
29+
| --------- | ----------- | ------------- | ---------------------------------- |
30+
| selectors | string | - | 选择器 |
31+
| type | 'single' \\| 'multiple' \\| 'none' | - | 类型 |
32+
| | single | - | 说明当前 HTML 片段只找到一个目标。 |
33+
| | multiple | - | 说明当前 HTML 片段找到多个目标。 |
34+
| | none | - | 说明没有在当前 HTML 片段找到。 |

‎docs/cn/type/index.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,21 @@ export interface CreateCrawlConfig extends CrawlCommonConfig {
88
enableRandomFingerprint?: boolean
99
baseUrl?: string
1010
intervalTime?: IntervalTime
11-
log?:
12-
| {
13-
start?: boolean
14-
process?: boolean
15-
result?: boolean
16-
}
17-
| boolean
11+
log?: LogOptions | boolean
1812
crawlPage?: {
19-
puppeteerLaunchOptions?: PuppeteerLaunchOptions // PuppeteerLaunchOptions 来自于 puppeteer
13+
puppeteerLaunchOptions?: PuppeteerLaunchOptions
2014
}
2115
}
2216
```
2317

24-
**默认值**
25-
26-
- mode: 'async'
27-
- enableRandomFingerprint: false
28-
- baseUrl: undefined
29-
- intervalTime: undefined
30-
- log: { start: true, process: true, result: true }
31-
- crawlPage: undefined
18+
| 参数 | 类型 | 默认值 | 描述 |
19+
| -- | -- | -- | -- |
20+
| mode | `async` \\| `sync` | `async` | 设置爬取模式 |
21+
| enableRandomFingerprint | boolean | false | 是否启动随机设备指纹 |
22+
| baseUrl | string | - | 基础地址 |
23+
| intervalTime | IntervalTime | - | 间隔时间 |
24+
| log | { start: true; process: true; result: true } \\| boolean | true | 打印日志 |
25+
| crawlPage | PuppeteerLaunchOptions | - | 传给 puppeteer.launch 用于创建浏览器实例 |
3226

3327
**外部类型**
3428

‎docs/cn/type/parse-elements.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ export interface CrawlOpenAIParseElementsContentOptions {
88
}
99
```
1010

11-
**默认值**
12-
13-
- message: undefined
11+
| 参数 | 类型 | 默认值 | 描述 |
12+
| ------- | ------ | ------ | ------------------ |
13+
| message | string | - | 你需要 AI 做的操作 |
1414

1515
**外部类型**
1616

@@ -27,7 +27,10 @@ export interface CrawlOpenAIParseElementsResult<
2727
}
2828
```
2929

30-
- type
31-
- single：说明当前 HTML 片段只找到一个目标。
32-
- multiple： 说明当前 HTML 片段找到多个目标。
33-
- none： 没有在当前 HTML 片段找到。
30+
| 参数 | 类型 | 默认值 | 描述 |
31+
| -------- | ----------- | ------------- | ---------------------------------- |
32+
| elements | T[] | - | 拿到的元素 |
33+
| type | 'single' \\| 'multiple' \\| 'none' | - | 类型 |
34+
| | single | - | 说明当前 HTML 片段只找到一个目标。 |
35+
| | multiple | - | 说明当前 HTML 片段找到多个目标。 |
36+
| | none | - | 说明没有在当前 HTML 片段找到。 |

‎docs/type/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#createCrawl
1+
# createCrawl
22

33
## CreateCrawlConfig
44

@@ -21,14 +21,14 @@ export interface CreateCrawlConfig extends CrawlCommonConfig {
2121
}
2222
```
2323

24-
**default value**
25-
26-
- mode: 'async'
27-
- enableRandomFingerprint: false
28-
- baseUrl: undefined
29-
- intervalTime: undefined
30-
- log: { start: true, process: true, result: true }
31-
- crawlPage: undefined
24+
| Parameter | Type | Default | Description |
25+
| ----------------------- | -- | ------- | ------------------------------------------------------- |
26+
| mode | `async` \\| `sync` | `async` | Set crawling mode |
27+
| enableRandomFingerprint | boolean | false | Whether to enable random device fingerprint |
28+
| baseUrl | string | - | Base URL |
29+
| intervalTime | IntervalTime | - | Interval time |
30+
| log | { start: true; process: true; result: true } \\| boolean | true | Print log |
31+
| crawlPage | PuppeteerLaunchOptions | - | Passed to puppeteer.launch to create a browser instance |
3232

3333
**External type**
3434

0 commit comments

Comments
 (0)