Remove AllowArbitraryParams

Author: zyc9012

CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to
 
 ### Added
 
-- Expose `EngineName`, `EngineParameters` and `AllowArbitraryParams` types.
+- Expose `EngineParameters` type.
 - Expose `InvalidArgumentTypesError` error.
 
 ### Changed

examples/deno/basic_ts/README.md

@@ -20,7 +20,6 @@ deno run example.ts
  following:
  ```ts
  import {
- AllowArbitraryParams,
  config,
  getJson,
  GoogleParameters,

examples/deno/basic_ts/example.ts

@@ -1,17 +1,12 @@
 import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
-import {
- AllowArbitraryParams,
- config,
- EngineParameters,
- getJson,
-} from "../../../mod.ts";
+import { config, EngineParameters, getJson } from "../../../mod.ts";
 
 const { API_KEY: apiKey } = loadSync();
 const params = {
  engine: "google",
  q: "Coffee",
  api_key: apiKey,
-} satisfies AllowArbitraryParams<EngineParameters<"google">>;
+} satisfies EngineParameters<"google">;
 
 // Show result as JSON (async/await)
 const response1 = await getJson(params);

examples/deno/pagination_ts/README.md

@@ -20,7 +20,6 @@ deno run example.ts
  following:
  ```ts
  import {
- AllowArbitraryParams,
  config,
  getJson,
  GoogleParameters,

examples/deno/pagination_ts/example.ts

@@ -1,10 +1,5 @@
 import { loadSync } from "https://deno.land/std@0.173.0/dotenv/mod.ts";
-import {
- AllowArbitraryParams,
- config,
- EngineParameters,
- getJson,
-} from "../../../mod.ts";
+import { config, EngineParameters, getJson } from "../../../mod.ts";
 
 const { API_KEY: apiKey } = loadSync();
 
@@ -15,7 +10,7 @@ const params = {
  engine: "google",
  q: "Coffee",
  api_key: apiKey,
-} satisfies AllowArbitraryParams<EngineParameters<"google">>;
+} satisfies EngineParameters<"google">;
 
 // Pagination (async/await)
 let page1 = await getJson(params);

examples/node/basic_ts_esm/example.ts

@@ -1,5 +1,5 @@
 import * as Dotenv from "dotenv";
-import { AllowArbitraryParams, config, EngineParameters, getJson } from "serpapi";
+import { config, EngineParameters, getJson } from "serpapi";
 
 Dotenv.config();
 const apiKey = process.env.API_KEY;
@@ -8,7 +8,7 @@ const params = {
  engine: "google",
  q: "Coffee",
  api_key: apiKey,
-} satisfies AllowArbitraryParams<EngineParameters<"google">>;
+} satisfies EngineParameters<"google">;
 
 // Show result as JSON (async/await)
 const response1 = await getJson(params);

examples/node/pagination_ts_esm/example.ts

@@ -1,5 +1,5 @@
 import * as Dotenv from "dotenv";
-import { AllowArbitraryParams, config, EngineParameters, getJson } from "serpapi";
+import { config, EngineParameters, getJson } from "serpapi";
 
 Dotenv.config();
 const apiKey = process.env.API_KEY;
@@ -11,7 +11,7 @@ const params = {
  engine: "google",
  q: "Coffee",
  api_key: apiKey,
-} satisfies AllowArbitraryParams<EngineParameters<"google">>;
+} satisfies EngineParameters<"google">;
 
 // Pagination (async/await)
 let page1 = await getJson(params);

mod.ts

@@ -10,7 +10,6 @@ export {
 export type {
  AccountApiParameters,
  AccountInformation,
- AllowArbitraryParams,
  BaseParameters,
  BaseResponse,
  EngineParameters,

src/types.ts

@@ -1,10 +1,5 @@
 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