@d-zero/puppeteer-scroll 1.0.0-alpha.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D-ZERO Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# `@d-zero/puppeteer-scroll`
+
+Puppeteerでスクロールするための関数を提供します。
+
+`IntersectionObserver`や`loading="lazy"`などの機能を使っているサイトに対して表示や読み込みを完了させるために、スクロールを行います。
+
+## インストール
+
+```sh
+yarn install @d-zero/puppeteer-scroll
+```
+
+## 使い方
+
+```ts
+import { scrollAllOver } from '@d-zero/puppeteer-scroll';
+
+const browser = await puppeteer.launch();
+const page = await browser.newPage();
+await page.goto('https://example.com');
+
+await scrollAllOver(page);
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { scrollAllOver } from './scroll-all-over.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { scrollAllOver } from './scroll-all-over.js';

package/dist/scroll-all-over.d.ts

@@ -0,0 +1,14 @@
+import type { Page } from 'puppeteer';
+export type Options = {
+    distance?: number;
+    interval?: number;
+};
+/**
+ * Scrolls the page vertically until the end or a maximum height is reached.
+ *
+ * @param page - The Puppeteer page object.
+ * @param options - Optional parameters for scrolling.
+ * @param options.distance - The distance to scroll on each iteration (default: 100).
+ * @param options.interval - The interval between each scroll iteration in milliseconds (default: 300).
+ */
+export declare function scrollAllOver(page: Page, options?: Options): Promise<void>;

package/dist/scroll-all-over.js

@@ -0,0 +1,26 @@
+/**
+ * Scrolls the page vertically until the end or a maximum height is reached.
+ *
+ * @param page - The Puppeteer page object.
+ * @param options - Optional parameters for scrolling.
+ * @param options.distance - The distance to scroll on each iteration (default: 100).
+ * @param options.interval - The interval between each scroll iteration in milliseconds (default: 300).
+ */
+export async function scrollAllOver(page, options) {
+    await page.evaluate(async (distance, interval) => {
+        distance = distance ?? document.documentElement.clientHeight - 5;
+        await new Promise((resolve) => {
+            let totalHeight = 0;
+            const timer = setInterval(() => {
+                const scrollHeight = document.body.scrollHeight;
+                window.scrollBy(0, distance);
+                totalHeight += distance;
+                if (totalHeight >= scrollHeight || totalHeight >= 100_000) {
+                    clearInterval(timer);
+                    window.scrollBy(0, 0);
+                    resolve();
+                }
+            }, interval);
+        });
+    }, options?.distance, options?.interval ?? 300);
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "@d-zero/puppeteer-scroll",
+	"version": "1.0.0-alpha.2",
+	"description": "Scroll function for puppeteer",
+	"author": "D-ZERO",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"clean": "tsc --build --clean"
+	},
+	"devDependencies": {
+		"puppeteer": "22.6.4"
+	},
+	"gitHead": "802df4fdb85892c8fab3bf1b376755e25ca2ca47"
+}