[Examples] Add basic Deno TS example

sebastianquek · sebastianquek · commit 5edf1e8dbf0f · 2023-01-17T17:00:25.000+08:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -4,7 +4,8 @@
     "version.ts",
     "src",
     "tests",
-    "scripts"
+    "scripts",
+    "examples/deno"
   ],
   "deno.inlayHints.enumMemberValues.enabled": false,
   "deno.inlayHints.functionLikeReturnTypes.enabled": false,
diff --git a/examples/deno/basic_ts/.env.example b/examples/deno/basic_ts/.env.example
@@ -0,0 +1 @@
+API_KEY=YOUR_API_KEY
diff --git a/examples/deno/basic_ts/README.md b/examples/deno/basic_ts/README.md
@@ -0,0 +1,27 @@
+# Deno basic TypeScript example
+
+## Usage
+
+1. Setup environment variables
+
+- Duplicate `.env.example` and name it `.env`.
+- Replace `YOUR_API_KEY` with your SerpApi API key.
+
+2. Run the example
+
+```
+deno run example.ts
+```
+
+## Notes
+
+- Imports rely on `mod.ts` found in the root folder.
+- To import the published module from deno.land, update the import to the
+  following:
+  ```ts
+  import {
+    config,
+    getJson,
+    GoogleParameters,
+  } from "https://deno.land/x/serpapi/mod.ts";
+  ```
diff --git a/examples/deno/basic_ts/example.ts b/examples/deno/basic_ts/example.ts
@@ -0,0 +1,20 @@
+import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
+import { config, getJson, GoogleParameters } from "../../../mod.ts";
+
+const { API_KEY: apiKey } = loadSync();
+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"]);
