From f4e9e4c26561e35d644053487c80f71e5e27ec77 Mon Sep 17 00:00:00 2001 From: Lipraty Date: Sat, 8 Jun 2024 16:44:17 +0800 Subject: [PATCH] chore(docs): add remote configs --- docs/plugins/puppeteer.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/docs/plugins/puppeteer.md b/docs/plugins/puppeteer.md index 6b2f3d5..9e7230a 100644 --- a/docs/plugins/puppeteer.md +++ b/docs/plugins/puppeteer.md @@ -4,7 +4,32 @@ ## 配置项 -### executablePath +### 连接配置 + +#### remote + +- 类型:`boolean` + +是否使用远程浏览器。 + +#### endpoint + +- 类型:`string` + +远程浏览器的地址。 + +::: tip +支持 HTTP 或 WebSocket 协议。请在启动浏览器时指定 `--remote-debugging-port` 参数以开启远程调试和确定其端口。 + +- HTTP 协议:`http(s)://{host}:{port}` +- WebSocket 协议:`ws(s)://{host}:{port}/devtools/browser/{id}` +::: + +#### headers + +- 类型:`Record` + +#### executablePath - 类型:`string` @@ -14,20 +39,22 @@ 目前仅支持 Chrome 和 Edge 的寻找。Firefox 用户请手动配置此项或者欢迎 pull request。 ::: -### headless +#### headless - 类型:`boolean` - 默认值:`true` 是否开启[无头模式](https://developer.chrome.com/blog/headless-chrome/)。 -### args +#### args - 类型:`string[]` 额外的浏览器参数。Chromium 参数可以参考[这个页面](https://peter.sh/experiments/chromium-command-line-switches/)。 -### defaultViewport +### 浏览器配置 + +#### defaultViewport 默认的设备缩放比率。有以下属性: @@ -35,7 +62,7 @@ - height: `number` 视图高度,默认为 600 - deviceScaleFactor: `number` 设备缩放比率,默认为 2 -### ignoreHTTPSErrors +#### ignoreHTTPSErrors - 类型:`boolean` - 默认值:`false`