Skip to content

Commit f13efe4

Browse files
committed
Update: Docs
1 parent 10116d7 commit f13efe4

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
English | [简体中文](https://github.com/coder-hxl/x-crawl/blob/main/docs/cn.md)
44

5-
x-crawl is a flexible nodejs crawler library. It is used to batch crawl data, network requests and download file resources. Support crawling data asynchronously or synchronously. Because it runs on nodejs, it will be crawler-friendly for JS/TS developers.
5+
x-crawl is a flexible nodejs crawler library. It is used to batch crawl data, network requests and download file resources. Support crawling data asynchronously or synchronously. Since it runs on nodejs, it is friendly to JS/TS developers.
66

7-
If it helps you, you can give [x-crawl repository](https://github.com/coder-hxl/x-crawl) a Star support.
7+
If you feel good, you can support [x-crawl repository](https://github.com/coder-hxl/x-crawl) with a Star.
88

99
## Features
1010

@@ -306,7 +306,10 @@ myXCrawl. startPolling({ h: 2, m: 30 }, (count, stopPolling) => {
306306
})
307307
```
308308

309-
The count attribute of the callback function records the current number of polling operations, and stopPolling is a callback function that can be called to terminate subsequent polling operations.
309+
Callback function parameters:
310+
311+
- The count attribute records the current number of polling operations.
312+
- stopPolling is a callback function, calling it can terminate subsequent polling operations.
310313

311314
### Request interval time
312315

docs/cn.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[English](https://github.com/coder-hxl/x-crawl#x-crawl) | 简体中文
44

5-
x-crawl 是一个灵活的 nodejs 爬虫库。用来批量爬取数据、网络请求以及下载文件资源。支持采用异步或同步的方式爬取数据。因跑在 nodejs 上,所以会对 JS/TS 的开发者做爬虫友好
5+
x-crawl 是一个灵活的 nodejs 爬虫库。用来批量爬取数据、网络请求以及下载文件资源。支持采用异步或同步的方式爬取数据。因跑在 nodejs 上,所以对 JS/TS 开发者友好
66

7-
如果对您有帮助,可以给 [x-crawl 存储库](https://github.com/coder-hxl/x-crawl) 点个 Star 支持一下。
7+
如果感觉不错,可以给 [x-crawl 存储库](https://github.com/coder-hxl/x-crawl) 点个 Star 支持一下。
88

99
## 特征
1010

@@ -304,7 +304,10 @@ myXCrawl.startPolling({ h: 2, m: 30 }, (count, stopPolling) => {
304304
})
305305
```
306306
307-
回调函数的 count 属性记录当前是第几次轮询操作,而 stopPolling 是一个回调函数,调用其可以终止后面的轮询操作。
307+
回调函数参数:
308+
309+
- count 属性记录当前是第几次轮询操作。
310+
- stopPolling 是一个回调函数,调用其可以终止后面的轮询操作。
308311
309312
### 请求间隔时间
310313

publish/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
English | [简体中文](https://github.com/coder-hxl/x-crawl/blob/main/docs/cn.md)
44

5-
x-crawl is a flexible nodejs crawler library. It is used to batch crawl data, network requests and download file resources. Support crawling data asynchronously or synchronously. Because it runs on nodejs, it will be crawler-friendly for JS/TS developers.
5+
x-crawl is a flexible nodejs crawler library. It is used to batch crawl data, network requests and download file resources. Support crawling data asynchronously or synchronously. Since it runs on nodejs, it is friendly to JS/TS developers.
66

7-
If it helps you, you can give [x-crawl repository](https://github.com/coder-hxl/x-crawl) a Star support.
7+
If you feel good, you can support [x-crawl repository](https://github.com/coder-hxl/x-crawl) with a Star.
88

99
## Features
1010

@@ -306,7 +306,10 @@ myXCrawl. startPolling({ h: 2, m: 30 }, (count, stopPolling) => {
306306
})
307307
```
308308

309-
The count attribute of the callback function records the current number of polling operations, and stopPolling is a callback function that can be called to terminate subsequent polling operations.
309+
Callback function parameters:
310+
311+
- The count attribute records the current number of polling operations.
312+
- stopPolling is a callback function, calling it can terminate subsequent polling operations.
310313

311314
### Request interval time
312315

0 commit comments

Comments
 (0)