[Examples] Add basic JS ESM Node example

sebastianquek · sebastianquek · commit 4e16ff77268b · 2023-01-17T17:04:24.000+08:00
diff --git a/examples/node/basic_js_esm/.env.example b/examples/node/basic_js_esm/.env.example
@@ -0,0 +1 @@
+API_KEY=YOUR_API_KEY
diff --git a/examples/node/basic_js_esm/README.md b/examples/node/basic_js_esm/README.md
@@ -0,0 +1,40 @@
+# Node.js basic JavaScript (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/basic_js_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
+    },
+    "scripts": {
+      "start": "node example.js"
+    }
+  }
+  ```
diff --git a/examples/node/basic_js_esm/example.js b/examples/node/basic_js_esm/example.js
@@ -0,0 +1,22 @@
+import * as Dotenv from "dotenv";
+import { config, getJson } from "serpapi";
+
+Dotenv.config();
+const apiKey = process.env.API_KEY;
+
+const params = {
+  q: "Coffee",
+  api_key: apiKey,
+};
+
+// Show result as JSON (async/await)
+const response1 = await getJson("google", params);
+console.log(response1["organic_results"]);
+
+// Show result as JSON (callback)
+getJson("google", params, (json) => console.log(json["organic_results"]));
+
+// Use global config
+config.api_key = apiKey;
+const response2 = await getJson("google", { q: "Coffee" });
+console.log(response2["organic_results"]);
diff --git a/examples/node/basic_js_esm/package-lock.json b/examples/node/basic_js_esm/package-lock.json
diff --git a/examples/node/basic_js_esm/package.json b/examples/node/basic_js_esm/package.json
@@ -0,0 +1,10 @@
+{
+  "type": "module",
+  "dependencies": {
+    "dotenv": "*",
+    "serpapi": "../../../npm"
+  },
+  "scripts": {
+    "start": "node example.js"
+  }
+}
