Add AllowArbitraryParams utility type

sebastianquek · sebastianquek · commit d49ad1d37833 · 2023-03-15T16:27:00.000+08:00
diff --git a/examples/deno/basic_ts/README.md b/examples/deno/basic_ts/README.md
@@ -20,6 +20,7 @@ deno run example.ts
   following:
   ```ts
   import {
+    AllowArbitraryParams,
     config,
     getJson,
     GoogleParameters,
diff --git a/examples/deno/basic_ts/example.ts b/examples/deno/basic_ts/example.ts
@@ -1,11 +1,16 @@
 import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
-import { config, getJson, GoogleParameters } from "../../../mod.ts";
+import {
+  AllowArbitraryParams,
+  config,
+  getJson,
+  GoogleParameters,
+} from "../../../mod.ts";
 
 const { API_KEY: apiKey } = loadSync();
 const params = {
   q: "Coffee",
   api_key: apiKey,
-} satisfies GoogleParameters;
+} satisfies AllowArbitraryParams<GoogleParameters>;
 
 // Show result as JSON (async/await)
 const response1 = await getJson("google", params);
diff --git a/examples/deno/pagination_ts/README.md b/examples/deno/pagination_ts/README.md
@@ -20,6 +20,7 @@ deno run example.ts
   following:
   ```ts
   import {
+    AllowArbitraryParams,
     config,
     getJson,
     GoogleParameters,
diff --git a/examples/deno/pagination_ts/example.ts b/examples/deno/pagination_ts/example.ts
@@ -1,5 +1,10 @@
 import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
-import { config, getJson, GoogleParameters } from "../../../mod.ts";
+import {
+  AllowArbitraryParams,
+  config,
+  getJson,
+  GoogleParameters,
+} from "../../../mod.ts";
 
 const { API_KEY: apiKey } = loadSync();
 
@@ -9,7 +14,7 @@ const extractLinks = (results: { link: string }[]) =>
 const params = {
   q: "Coffee",
   api_key: apiKey,
-} satisfies GoogleParameters;
+} satisfies AllowArbitraryParams<GoogleParameters>;
 
 // Pagination (async/await)
 let page1 = await getJson("google", params);
diff --git a/examples/node/basic_ts_esm/example.ts b/examples/node/basic_ts_esm/example.ts
@@ -1,13 +1,13 @@
 import * as Dotenv from "dotenv";
-import { config, getJson, GoogleParameters } from "serpapi";
+import { AllowArbitraryParams, config, getJson, GoogleParameters } from "serpapi";
 
 Dotenv.config();
 const apiKey = process.env.API_KEY;
 
 const params = {
   q: "Coffee",
   api_key: apiKey,
-} satisfies GoogleParameters;
+} satisfies AllowArbitraryParams<GoogleParameters>;
 
 // Show result as JSON (async/await)
 const response1 = await getJson("google", params);
diff --git a/examples/node/pagination_ts_esm/example.ts b/examples/node/pagination_ts_esm/example.ts
@@ -1,5 +1,5 @@
 import * as Dotenv from "dotenv";
-import { config, getJson, GoogleParameters } from "serpapi";
+import { AllowArbitraryParams, config, getJson, GoogleParameters } from "serpapi";
 
 Dotenv.config();
 const apiKey = process.env.API_KEY;
@@ -10,7 +10,7 @@ const extractLinks = (results: { link: string }[]) =>
 const params = {
   q: "Coffee",
   api_key: apiKey,
-} satisfies GoogleParameters;
+} satisfies AllowArbitraryParams<GoogleParameters>;
 
 // Pagination (async/await)
 let page1 = await getJson("google", params);
diff --git a/mod.ts b/mod.ts
@@ -6,6 +6,7 @@ export { InvalidTimeoutError, MissingApiKeyError } from "./src/errors.ts";
 export type {
   AccountApiParameters,
   AccountInformation,
+  AllowArbitraryParams,
   BaseParameters,
   BaseResponse,
   EngineName,
diff --git a/src/serpapi.ts b/src/serpapi.ts
@@ -1,6 +1,7 @@
 import {
   AccountApiParameters,
   AccountInformation,
+  AllowArbitraryParams,
   BaseResponse,
   EngineName,
   EngineParameters,
@@ -71,7 +72,7 @@ const SEARCH_ARCHIVE_PATH = `/searches`;
  */
 export async function getJson<
   E extends EngineName = EngineName,
-  P extends (EngineParameters<E> & Record<string, unknown>) = EngineParameters<
+  P extends AllowArbitraryParams<EngineParameters<E>> = EngineParameters<
     E
   >,
 >(
diff --git a/src/types.ts b/src/types.ts
@@ -1,5 +1,10 @@
 import { EngineMap } from "./engines/engine_map.ts";
 
+/**
+ * Allow arbitrary parameters in addition to parameters in T.
+ */
+export type AllowArbitraryParams<T> = T & Record<string, unknown>;
+
 export type BaseParameters = {
   /**
    * Parameter defines the device to use to get the results. It can be set to
