[Examples] Add pagination TS ESM Node example

Author: sebastianquek

examples/node/pagination_ts_esm/.env.example

@@ -0,0 +1 @@
+API_KEY=YOUR_API_KEY

examples/node/pagination_ts_esm/README.md

@@ -0,0 +1,44 @@
+# Node.js pagination TypeScript (ESM) example
+
+## Usage
+
+1. Build module
+
+```bash
+cd ../../../   # Navigate to the root folder
+deno task npm
+```
+
+2. Setup environment variables
+
+- Duplicate `.env.example` and name it `.env`.
+- Replace `YOUR_API_KEY` with your SerpApi API key.
+
+3. Install dependencies and run example
+
+```bash
+cd examples/node/pagination_ts_esm
+npm i
+npm start
+```
+
+## Notes
+
+- If you want to run the example without building the module, you can update
+  `package.json` to depend on the published `serpapi` npm module instead:
+  ```json
+  {
+    "type": "module",
+    "dependencies": {
+      "dotenv": "*",
+      "serpapi": "*" // Relies on the npm module
+    },
+    "devDependencies": {
+      "@types/node": "*",
+      "typescript": "*"
+    },
+    "scripts": {
+      "start": "npx ts-node example.ts"
+    }
+  }
+  ```

examples/node/pagination_ts_esm/example.ts

@@ -0,0 +1,70 @@
+import * as Dotenv from "dotenv";
+import { config, getJson, GoogleParameters } from "serpapi";
+
+Dotenv.config();
+const apiKey = process.env.API_KEY;
+
+const extractLinks = (results: { link: string }[]) =>
+  results.map((r) => r.link);
+
+const params = {
+  q: "Coffee",
+  api_key: apiKey,
+} satisfies GoogleParameters;
+
+// Pagination (async/await)
+let page1 = await getJson("google", params);
+console.log(
+  "First page links",
+  extractLinks(page1.organic_results),
+);
+let page2 = await page1.next?.();
+console.log(
+  "Second page links",
+  extractLinks(page2?.organic_results),
+);
+
+// Pagination (callback)
+getJson("google", params, (page1) => {
+  console.log(
+    "First page links",
+    extractLinks(page1.organic_results),
+  );
+  page1.next?.((page2) => {
+    console.log(
+      "Second page links",
+      extractLinks(page2.organic_results),
+    );
+  });
+});
+
+// Use global config
+config.api_key = apiKey;
+page1 = await getJson("google", { q: "Coffee" });
+page2 = await page1.next?.();
+console.log(
+  "Second page links",
+  extractLinks(page2?.organic_results),
+);
+
+// Pagination loop (async/await)
+let links: string[] = [];
+let page;
+page = await getJson("google", { q: "Coffee" });
+while (page) {
+  links.push(...extractLinks(page.organic_results));
+  if (links.length >= 30) break;
+  page = await page.next?.();
+}
+console.log(links);
+
+// Pagination loop (callback)
+links = [];
+getJson("google", { q: "Coffee" }, (page) => {
+  links.push(...extractLinks(page.organic_results));
+  if (links.length < 30 && page.next) {
+    page.next();
+  } else {
+    console.log(links);
+  }
+});

examples/node/pagination_ts_esm/package-lock.json

@@ -0,0 +1,14 @@
+{
+  "type": "module",
+  "dependencies": {
+    "dotenv": "*",
+    "serpapi": "../../../npm"
+  },
+  "devDependencies": {
+    "@types/node": "*",
+    "typescript": "*"
+  },
+  "scripts": {
+    "start": "npx ts-node example.ts"
+  }
+}

examples/node/pagination_ts_esm/package.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "moduleResolution": "Node"
+  },
+  "ts-node": {
+    "esm": true
+  }
+}