adds mandatory key parameter, makes events optional

OpenCageData · Oct 18, 2023 · 0ba1b6e · 0ba1b6e
1 parent 424bf06
commit 0ba1b6e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/examples/nodejs-example/nodejs-example.js b/examples/nodejs-example/nodejs-example.js
@@ -1,3 +1,4 @@
+// @ts-check
 const { OpenCageGeoSearchPlugin } = require('@opencage/geosearch-core');
 
 // eslint-disable-next-line import/no-extraneous-dependencies
@@ -6,7 +7,7 @@ require('isomorphic-unfetch');
 console.log(typeof OpenCageGeoSearchPlugin);
 
 const options = {
-  key: process.env.OPENCAGE_SEARCH_TOKEN,
+  key: process.env.OPENCAGE_SEARCH_TOKEN || '',
 };
 
 const plugin = OpenCageGeoSearchPlugin(options);

diff --git a/packages/geosearch-core/index.d.ts b/packages/geosearch-core/index.d.ts
@@ -7,6 +7,10 @@ import {
 
 declare module '@opencage/geosearch-core' {
   interface OpenCageGeoSearchPluginOptions {
+    /**
+     * The GEOSEARCH Key
+     */
+    key: string;
     /**
      * restricts the possible results to a defined bounding box.
      *
@@ -92,6 +96,6 @@ declare module '@opencage/geosearch-core' {
 
   export function OpenCageGeoSearchPlugin(
     options: OpenCageGeoSearchPluginOptions,
-    events: OpenCageGeoSearchPluginEvents
+    events?: OpenCageGeoSearchPluginEvents
   ): AutocompletePlugin<any, any>;
 }