Add pagination example

Author: zyc9012

CONTRIBUTING.md

@@ -111,7 +111,7 @@ To run [examples](./examples/) on your local source files, follow these steps.
        "serpapi": "../../../npm"
      },
      "scripts": {
-       "start": "node example.js"
+       "start": "node basic_example.js"
      }
    }
    ```

README.md

@@ -108,6 +108,15 @@ await getJson({ engine: "google", q: "coffee" }); // uses the API key defined in
 await getJson({ engine: "google", api_key: API_KEY_2, q: "coffee" }); // API_KEY_2 will be used
 ```
 
+## Pagination
+
+There's no built-in pagination support in this library, but you can always do it
+manually. You can find pagination examples here:
+
+- [Pagination example (Node.js >= 7)](examples/node/js_node_7_up/pagination_example.js)
+- [Pagination example (Node.js >= 14)](examples/node/js_node_14_up/pagination_example.js)
+- [Pagination example (Deno)](examples/deno/pagination_example.ts)
+
 ## Functions
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->

examples/deno/README.md

@@ -10,7 +10,8 @@
 2. Run the example
 
 ```
-deno run example.ts
+deno run basic_example.ts
+deno run pagination_example.ts
 ```
 
 ## Notes

examples/deno/example.ts renamed to examples/deno/basic_example.ts

@@ -0,0 +1,15 @@
+import { loadSync } from "https://deno.land/[email protected]/dotenv/mod.ts";
+import { config, getJson } from "../../mod.ts";
+
+const { API_KEY: apiKey } = loadSync();
+config.api_key = apiKey;
+
+// Get the first page
+const page = await getJson({ engine: "google", q: "Coffee" });
+// Parse SerpApi search URL to the next page
+const nextUrl = new URL(page.serpapi_pagination.next);
+// Extract the request parameters
+const nextParams = Object.fromEntries(nextUrl.searchParams);
+// Get the next page
+const nextPage = await getJson(nextParams);
+console.log(nextPage);

examples/deno/pagination_example.ts

@@ -5,6 +5,6 @@
     "serpapi": "*"
   },
   "scripts": {
-    "start": "node example.js"
+    "start": "node basic_example.js"
   }
 }

examples/node/js_node_14_up/example.js renamed to examples/node/js_node_14_up/basic_example.js

@@ -0,0 +1,23 @@
+/**
+ * Example works for Node.js 14 and newer.
+ * - Uses ESM imports which is supported from Node.js 13.2.0.
+ *   https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#browser_compatibility
+ * - Uses top-level await which is supported from Node.js 14.8.0.
+ *   https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#browser_compatibility
+ */
+
+import * as Dotenv from "dotenv";
+import { config, getJson } from "serpapi";
+
+Dotenv.config();
+config.api_key = process.env.API_KEY;
+
+// Get the first page
+const page = await getJson({ engine: "google", q: "Coffee" });
+// Parse SerpApi search URL to the next page
+const nextUrl = new URL(page.serpapi_pagination.next);
+// Extract the request parameters
+const nextParams = Object.fromEntries(nextUrl.searchParams);
+// Get the next page
+const nextPage = await getJson(nextParams);
+console.log(nextPage);

examples/node/js_node_14_up/package.json

@@ -4,6 +4,6 @@
     "serpapi": "*"
   },
   "scripts": {
-    "start": "node example.js"
+    "start": "node basic_example.js"
   }
 }

examples/node/js_node_14_up/pagination_example.js

@@ -0,0 +1,25 @@
+/**
+ * Example works for Node.js 7 and newer.
+ */
+
+const Dotenv = require("dotenv");
+const { config, getJson } = require("serpapi");
+const url = require("url");
+const qs = require("querystring");
+
+Dotenv.config();
+config.api_key = process.env.API_KEY;
+
+const run = async () => {
+  // Get the first page
+  const page = await getJson({ engine: "google", q: "Coffee" });
+  // Parse SerpApi search URL to the next page
+  const nextUrl = url.parse(page.serpapi_pagination.next);
+  // Extract the request parameters
+  const nextParams = qs.parse(nextUrl.query);
+  // Get the next page
+  const nextPage = await getJson(nextParams);
+  console.log(nextPage);
+};
+
+run();