Update: Docs

Author: coder-hxl

README.md

@@ -2,7 +2,7 @@
 
 English | [简体中文](https://github.com/coder-hxl/x-crawl/blob/main/docs/cn.md)
 
-X-Crawl is a flexible Nodejs reptile bank. Used to crawl pages, batch network requests, and download file resources in batches. There are 5 kinds of RequestConfig writing, 3 ways to obtain results, and crawl data asynchronous or synchronized mode. Run on Nodejs and be friendly to JS/TS developers.
+x-crawl is a flexible nodejs crawler library. Used to crawl pages, batch network requests, and batch download file resources. Crawl data in asynchronous or synchronous mode, 3 ways to get results, and 5 ways to write requestConfig. Runs on nodejs, friendly to JS/TS developers.
 
 If you feel good, you can support [x-crawl repository](https://github.com/coder-hxl/x-crawl) with a Star.
 
@@ -37,9 +37,9 @@ We can do the following:
       + [Choose crawling mode](#Choose-crawling-mode)
       + [Multiple crawler application instances](#Multiple-crawler-application-instances)
     * [Crawl page](#Crawl-page)
-      + [jsdom](#jsdom)
-      + [browser](#browser)
-      + [page](#page)
+      + [jsdom instance](#jsdom-instance)
+      + [browser instance](#browser-instance)
+      + [page instance](#page-instance)
     * [Crawl interface](#Crawl-interface)
     * [Crawl files](#Crawl-files)
     * [Start polling](#Start-polling)
@@ -212,19 +212,39 @@ myXCrawl.crawlPage('https://xxx.com').then(res => {
 })
 ```
 
-#### jsdom
+#### jsdom instance
 
 Refer to [jsdom](https://github.com/jsdom/jsdom) for specific usage.
 
-#### browser
+#### browser instance
 
-**Purpose of calling close: **browser will keep running, so the file will not be terminated. Do not call [crawlPage](#crawlPage) or [page](#page) if you need to use it later. When you modify the properties of the browser object, it will affect the browser inside the crawlPage of the crawler instance, the returned page, and the browser, because the browser is shared within the crawlPage API of the crawler instance.
+The browser instance is a headless browser without a UI shell. What he does is to bring **all modern network platform functions** provided by the browser rendering engine to the code.
+
+**Purpose of calling close:** The browser instance will always be running internally, causing the file not to be terminated. Do not call [crawlPage](#crawlPage) or [page](#page) if you need to use it later. When you modify the properties of a browser instance, it will affect the browser instance inside the crawlPage API of the crawler instance, the page instance that returns the result, and the browser instance, because the browser instance is shared within the crawlPage API of the same crawler instance.
 
 Refer to [browser](https://pptr.dev/api/puppeteer.browser) for specific usage.
 
-#### page
+#### page instance
+
+**Take Screenshot**
+
+```js
+import xCrawl from 'x-crawl'
+
+const testXCrawl = xCrawl({ timeout: 10000 })
+
+testXCrawl
+   .crawlPage('https://xxx.com')
+   .then(async (res) => {
+     const { page } = res
+
+     await page.screenshot({ path: './upload/page.png' })
+
+     console.log('Screen capture is complete')
+   })
+```
 
-The page attribute can be used for interactive operations such as events. For details, refer to [page](https://pptr.dev/api/puppeteer.page).
+The page instance can also perform interactive operations such as events. For details, refer to [page](https://pptr.dev/api/puppeteer.page).
 
 ### Crawl interface
 

docs/cn.md

@@ -2,7 +2,7 @@
 
 [English](https://github.com/coder-hxl/x-crawl#x-crawl) | 简体中文
 
-x-crawl 是一个灵活的 nodejs 爬虫库。用来爬取页面、批量网络请求以及批量下载文件资源。有 5 种 requestConfig 的写法，3 种获取结果的写法，异步或同步模式爬取数据。跑在 nodejs 上，对 JS/TS 开发者友好。
+x-crawl 是一个灵活的 nodejs 爬虫库。用来爬取页面、批量网络请求以及批量下载文件资源。异步或同步模式爬取数据，3 种获取结果的写法，有 5 种 requestConfig 的写法。跑在 nodejs 上，对 JS/TS 开发者友好。
 
 如果感觉不错，可以给 [x-crawl 存储库](https://github.com/coder-hxl/x-crawl) 点个 Star 支持一下。
 
@@ -39,11 +39,9 @@ crawlPage API 内部使用 [puppeteer](https://github.com/puppeteer/puppeteer) 
       + [选择爬取模式](#选择爬取模式)
       + [多个爬虫应用实例](#多个爬虫应用实例)
     * [爬取页面](#爬取页面)
-    
-      + [jsdom](#jsdom)
-      + [browser](#browser)
-      + [page](#page)
-    
+      + [jsdom 实例](#jsdom-实例)
+      + [browser 实例](#browser-实例)
+      + [page-实例](#page-实例)
     * [爬取接口](#爬取接口)
     * [爬取文件](#爬取文件)
     * [启动轮询](#启动轮询)
@@ -211,19 +209,39 @@ myXCrawl.crawlPage('https://xxx.com').then(res => {
 })
 ```
 
-#### jsdom
+#### jsdom 实例
 
 具体使用参考 [jsdom](https://github.com/jsdom/jsdom) 。
 
-#### browser
+#### browser 实例
 
-**调用 close 的目的：**browser 会一直保持运行，造成文件不会终止。如果后面还需要用到 [crawlPage](#crawlPage) 或者 [page](#page) 请勿调用。当您修改 browser 对象的属性时，会对该爬虫实例的 crawlPage 内部的 browser 和返回的 page 以及 browser 造成影响，因为 browser 在爬虫实例的 crawlPage API 内是共享的。
+browser 实例他是个无头浏览器，并无 UI 外壳，他做的是将浏览器渲染引擎提供的**所有现代网络平台功能**带到代码中。
+
+**调用 close 的目的：** browser 实例内部会一直处于运行，造成文件不会终止。如果后面还需要用到 [crawlPage](#crawlPage) 或者 [page](#page) 请勿调用。当您修改 browser 实例的属性时，会对该爬虫实例 crawlPage API 内部的 browser 实例和返回结果的 page 实例以及 browser 实例造成影响，因为 browser 实例在同一个爬虫实例的 crawlPage API 内是共享的。
 
 具体使用参考 [browser](https://pptr.dev/api/puppeteer.browser) 。
 
-#### page
+#### page 实例
+
+**获取屏幕截图**
+
+```js
+import xCrawl from 'x-crawl'
+
+const testXCrawl = xCrawl({ timeout: 10000 })
+
+testXCrawl
+  .crawlPage('https://xxx.com')
+  .then(async (res) => {
+    const { page } = res
+
+    await page.screenshot({ path: './upload/page.png' })
+
+    console.log('获取屏幕截图完毕')
+  })
+```
 
-page 属性可以做事件之类的交互操作，具体使用参考 [page](https://pptr.dev/api/puppeteer.page) 。
+page 实例还可以做事件之类的交互操作，具体使用参考 [page](https://pptr.dev/api/puppeteer.page) 。
 
 ### 爬取接口
 

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "x-crawl",
-  "version": "3.2.3",
+  "version": "3.2.4",
   "author": "coderHXL",
   "description": "x-crawl is a flexible nodejs crawler library. ",
   "license": "MIT",

publish/README.md

@@ -2,7 +2,7 @@
 
 English | [简体中文](https://github.com/coder-hxl/x-crawl/blob/main/docs/cn.md)
 
-X-Crawl is a flexible Nodejs reptile bank. Used to crawl pages, batch network requests, and download file resources in batches. There are 5 kinds of RequestConfig writing, 3 ways to obtain results, and crawl data asynchronous or synchronized mode. Run on Nodejs and be friendly to JS/TS developers.
+x-crawl is a flexible nodejs crawler library. Used to crawl pages, batch network requests, and batch download file resources. Crawl data in asynchronous or synchronous mode, 3 ways to get results, and 5 ways to write requestConfig. Runs on nodejs, friendly to JS/TS developers.
 
 If you feel good, you can support [x-crawl repository](https://github.com/coder-hxl/x-crawl) with a Star.
 
@@ -37,9 +37,9 @@ We can do the following:
       + [Choose crawling mode](#Choose-crawling-mode)
       + [Multiple crawler application instances](#Multiple-crawler-application-instances)
     * [Crawl page](#Crawl-page)
-      + [jsdom](#jsdom)
-      + [browser](#browser)
-      + [page](#page)
+      + [jsdom instance](#jsdom-instance)
+      + [browser instance](#browser-instance)
+      + [page instance](#page-instance)
     * [Crawl interface](#Crawl-interface)
     * [Crawl files](#Crawl-files)
     * [Start polling](#Start-polling)
@@ -212,19 +212,39 @@ myXCrawl.crawlPage('https://xxx.com').then(res => {
 })
 ```
 
-#### jsdom
+#### jsdom instance
 
 Refer to [jsdom](https://github.com/jsdom/jsdom) for specific usage.
 
-#### browser
+#### browser instance
 
-**Purpose of calling close: **browser will keep running, so the file will not be terminated. Do not call [crawlPage](#crawlPage) or [page](#page) if you need to use it later. When you modify the properties of the browser object, it will affect the browser inside the crawlPage of the crawler instance, the returned page, and the browser, because the browser is shared within the crawlPage API of the crawler instance.
+The browser instance is a headless browser without a UI shell. What he does is to bring **all modern network platform functions** provided by the browser rendering engine to the code.
+
+**Purpose of calling close:** The browser instance will always be running internally, causing the file not to be terminated. Do not call [crawlPage](#crawlPage) or [page](#page) if you need to use it later. When you modify the properties of a browser instance, it will affect the browser instance inside the crawlPage API of the crawler instance, the page instance that returns the result, and the browser instance, because the browser instance is shared within the crawlPage API of the same crawler instance.
 
 Refer to [browser](https://pptr.dev/api/puppeteer.browser) for specific usage.
 
-#### page
+#### page instance
+
+**Take Screenshot**
+
+```js
+import xCrawl from 'x-crawl'
+
+const testXCrawl = xCrawl({ timeout: 10000 })
+
+testXCrawl
+   .crawlPage('https://xxx.com')
+   .then(async (res) => {
+     const { page } = res
+
+     await page.screenshot({ path: './upload/page.png' })
+
+     console.log('Screen capture is complete')
+   })
+```
 
-The page attribute can be used for interactive operations such as events. For details, refer to [page](https://pptr.dev/api/puppeteer.page).
+The page instance can also perform interactive operations such as events. For details, refer to [page](https://pptr.dev/api/puppeteer.page).
 
 ### Crawl interface
 

publish/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-crawl",
-  "version": "3.2.3",
+  "version": "3.2.4",
   "author": "coderHXL",
   "description": "x-crawl is a flexible nodejs crawler library.",
   "license": "MIT",