@d-zero/puppeteer-screenshot 3.3.10-alpha.2 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -12
- package/dist/screenshot.d.ts +3 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -47,18 +47,20 @@ const result = await screenshot(page, 'https://example.com', {
|
|
|
47
47
|
|
|
48
48
|
## オプション
|
|
49
49
|
|
|
50
|
-
| オプション | 型 | 説明
|
|
51
|
-
| ----------------- | --------------------------- |
|
|
52
|
-
| `id` | `string` | スクリーンショットのカスタム識別子。省略時はURLからファイル名が生成されます
|
|
53
|
-
| `path` | `string` | スクリーンショットの保存先パス。指定するとファイルに保存されます（例: `path/to/save.png`はサイズ別に`save@desktop.png`、`save@mobile.png`などに保存）
|
|
54
|
-
| `sizes` | `Sizes` | スクリーンショットを撮るサイズと解像度の設定。省略時はデフォルトサイズ（desktop、tablet、mobile）が使用されます
|
|
55
|
-
| `hooks` | `PageHook[]` | ページスキャン時に実行するフック関数の配列
|
|
56
|
-
| `listener` | `Listener<ScreenshotPhase>` | スクリーンショット処理の各フェーズをリスンする関数。`screenshotListener`を使うと標準のログ出力が得られます
|
|
57
|
-
| `domOnly` | `boolean` | `true`の場合、スクリーンショットの撮影をスキップしてDOMのみを取得します（デフォルト: `false`）
|
|
58
|
-
| `selector` | `string` | 特定の要素のみをスクリーンショット撮影するためのCSSセレクター
|
|
59
|
-
| `ignore` | `string` | スクリーンショットから除外する（非表示にする）要素のCSSセレクター
|
|
60
|
-
| `timeout` | `number` | カスタムタイムアウト値（ミリ秒）
|
|
61
|
-
| `openDisclosures` | `boolean` | `true`の場合、disclosure要素（`<details>`と`button[aria-expanded="false"]`）を展開します（最大1000回まで繰り返す）
|
|
50
|
+
| オプション | 型 | 説明 |
|
|
51
|
+
| ----------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
52
|
+
| `id` | `string` | スクリーンショットのカスタム識別子。省略時はURLからファイル名が生成されます |
|
|
53
|
+
| `path` | `string` | スクリーンショットの保存先パス。指定するとファイルに保存されます（例: `path/to/save.png`はサイズ別に`save@desktop.png`、`save@mobile.png`などに保存） |
|
|
54
|
+
| `sizes` | `Sizes` | スクリーンショットを撮るサイズと解像度の設定。省略時はデフォルトサイズ（desktop、tablet、mobile）が使用されます |
|
|
55
|
+
| `hooks` | `PageHook[]` | ページスキャン時に実行するフック関数の配列 |
|
|
56
|
+
| `listener` | `Listener<ScreenshotPhase>` | スクリーンショット処理の各フェーズをリスンする関数。`screenshotListener`を使うと標準のログ出力が得られます |
|
|
57
|
+
| `domOnly` | `boolean` | `true`の場合、スクリーンショットの撮影をスキップしてDOMのみを取得します（デフォルト: `false`） |
|
|
58
|
+
| `selector` | `string` | 特定の要素のみをスクリーンショット撮影するためのCSSセレクター |
|
|
59
|
+
| `ignore` | `string` | スクリーンショットから除外する（非表示にする）要素のCSSセレクター |
|
|
60
|
+
| `timeout` | `number` | カスタムタイムアウト値（ミリ秒） |
|
|
61
|
+
| `openDisclosures` | `boolean` | `true`の場合、disclosure要素（`<details>`と`button[aria-expanded="false"]`）を展開します（最大1000回まで繰り返す） |
|
|
62
|
+
| `scrollInterval` | `number \| DelayOptions` | スクロール間隔（ミリ秒）。固定値またはランダム範囲（`{ random: ... }`）を指定可能。未指定時は[`@d-zero/puppeteer-scroll`](../puppeteer-scroll/README.md#デフォルト挙動)のデフォルト |
|
|
63
|
+
| `scrollDistance` | `number \| DelayOptions` | 1スクロールステップで進むピクセル数。固定値またはランダム範囲を指定可能。未指定時は同上 |
|
|
62
64
|
|
|
63
65
|
## エクスポート
|
|
64
66
|
|
package/dist/screenshot.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Screenshot, ScreenshotPhase } from './types.js';
|
|
2
2
|
import type { Listener } from '@d-zero/puppeteer-general-actions';
|
|
3
3
|
import type { PageHook, Sizes } from '@d-zero/puppeteer-page-scan';
|
|
4
|
+
import type { DelayOptions } from '@d-zero/shared/delay';
|
|
4
5
|
import type { Page } from 'puppeteer';
|
|
5
6
|
type Options = {
|
|
6
7
|
id?: string;
|
|
@@ -13,6 +14,8 @@ type Options = {
|
|
|
13
14
|
ignore?: string;
|
|
14
15
|
timeout?: number;
|
|
15
16
|
openDisclosures?: boolean;
|
|
17
|
+
scrollInterval?: number | DelayOptions;
|
|
18
|
+
scrollDistance?: number | DelayOptions;
|
|
16
19
|
};
|
|
17
20
|
/**
|
|
18
21
|
* Takes screenshots of a web page at different sizes and resolutions.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@d-zero/puppeteer-screenshot",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.4.0",
|
|
4
4
|
"description": "Screenshot utility for puppeteer",
|
|
5
5
|
"author": "D-ZERO",
|
|
6
6
|
"license": "MIT",
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"clean": "tsc --build --clean"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@d-zero/puppeteer-general-actions": "1.2.3
|
|
27
|
-
"@d-zero/puppeteer-page-scan": "4.
|
|
28
|
-
"@d-zero/shared": "0.
|
|
26
|
+
"@d-zero/puppeteer-general-actions": "1.2.3",
|
|
27
|
+
"@d-zero/puppeteer-page-scan": "4.5.0",
|
|
28
|
+
"@d-zero/shared": "0.22.0"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
31
|
"puppeteer": "24.37.5"
|
|
@@ -38,5 +38,5 @@
|
|
|
38
38
|
"url": "https://github.com/d-zero-dev/tools.git",
|
|
39
39
|
"directory": "packages/@d-zero/puppeteer-screenshot"
|
|
40
40
|
},
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "2d24e08c0cb516b7ea9d07a4301eb991193cca11"
|
|
42
42
|
}
|