[Examples] Add basic TS ESM Node example

sebastianquek · sebastianquek · commit 58ba285a512f · 2023-01-17T16:51:11.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .env
 cov_profile/
-npm/
+npm/
+node_modules/
diff --git a/deno.json b/deno.json
@@ -9,12 +9,12 @@
   },
   "fmt": {
     "files": {
-      "exclude": ["npm/"]
+      "exclude": ["npm/", "examples/node"]
     }
   },
   "lint": {
     "files": {
-      "exclude": ["npm/"]
+      "exclude": ["npm/", "examples/node"]
     }
   }
 }
diff --git a/examples/node/basic_ts_esm/.env.example b/examples/node/basic_ts_esm/.env.example
@@ -0,0 +1 @@
+API_KEY=YOUR_API_KEY
diff --git a/examples/node/basic_ts_esm/README.md b/examples/node/basic_ts_esm/README.md
@@ -0,0 +1,44 @@
+# Node.js basic 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/basic_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"
+    }
+  }
+  ```
diff --git a/examples/node/basic_ts_esm/example.ts b/examples/node/basic_ts_esm/example.ts
@@ -0,0 +1,22 @@
+import * as Dotenv from "dotenv";
+import { config, getJson, GoogleParameters } from "serpapi";
+
+Dotenv.config();
+const apiKey = process.env.API_KEY;
+
+const params = {
+  q: "Coffee",
+  api_key: apiKey,
+} satisfies GoogleParameters;
+
+// 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_ts_esm/package-lock.json b/examples/node/basic_ts_esm/package-lock.json
diff --git a/examples/node/basic_ts_esm/package.json b/examples/node/basic_ts_esm/package.json
@@ -0,0 +1,14 @@
+{
+  "type": "module",
+  "dependencies": {
+    "dotenv": "*",
+    "serpapi": "../../../npm"
+  },
+  "devDependencies": {
+    "@types/node": "*",
+    "typescript": "*"
+  },
+  "scripts": {
+    "start": "npx ts-node example.ts"
+  }
+}
diff --git a/examples/node/basic_ts_esm/tsconfig.json b/examples/node/basic_ts_esm/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "moduleResolution": "Node"
+  },
+  "ts-node": {
+    "esm": true
+  }
+}
diff --git a/scripts/build_npm.ts b/scripts/build_npm.ts
@@ -5,6 +5,7 @@ await emptyDir("./npm");
 
 await build({
   entryPoints: ["./mod.ts"],
+  rootTestDir: "./tests",
   outDir: "./npm",
   shims: {
     deno: true, // Required for `Deno.test`, `Deno.env`, etc.

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 .env
 cov_profile/
 -npm/
 +npm/
 +node_modules/
Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,12 @@`
`9`	`9`	`},`
`10`	`10`	`"fmt": {`
`11`	`11`	`"files": {`
`12`		`- "exclude": ["npm/"]`
	`12`	`+ "exclude": ["npm/", "examples/node"]`
`13`	`13`	`}`
`14`	`14`	`},`
`15`	`15`	`"lint": {`
`16`	`16`	`"files": {`
`17`		`- "exclude": ["npm/"]`
	`17`	`+ "exclude": ["npm/", "examples/node"]`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`	`}`