Merge pull request #56 from metehandemir/debounce-options

feat: add debounceOptions

Author: EQuimper

README.md

@@ -24,18 +24,19 @@ The `useGoogleAutocomplete` hook takes 2 arguments
 
 # Config object
 
-| Property     | Description                                                                                            |
-| ------------ | ------------------------------------------------------------------------------------------------------ |
-| debounce     | optional - default 300                                                                                 |
-| language     | optional - default 'en'                                                                                |
-| queryTypes   | optional - default address - https://developers.google.com/places/web-service/autocomplete#place_types |
-| minLength    | optional - default 2 - this is the min length of the term search before start                          |
-| components   | optional - A grouping of places to which you would like to restrict your results                       |
-| radius       | optional - The distance (in meters) within which to return place results                               |
-| lat          | optional - The latitude. If provided, lng is required                                                  |
-| lng          | optional - The longitude. If provided, lat is required                                                  |
-| strictBounds | optional - Returns only places that are strictly within the region defined by location and radius.     |
-| proxyUrl     | optional - This is required if you want to use the hook in a Web based platform. Since we dont use the Google SDK,  the http call will fail because of issues related to CORS unless a proxyUrl is provided                       |
+| Property        | Description                                                                                            |
+| --------------- | ------------------------------------------------------------------------------------------------------ |
+| debounce        | optional - default 300                                                                                 |
+| debounceOptions | optional - Configuration options for debounce behavior.                                                |
+| language        | optional - default 'en'                                                                                |
+| queryTypes      | optional - default address - https://developers.google.com/places/web-service/autocomplete#place_types |
+| minLength       | optional - default 2 - this is the min length of the term search before start                          |
+| components      | optional - A grouping of places to which you would like to restrict your results                       |
+| radius          | optional - The distance (in meters) within which to return place results                               |
+| lat             | optional - The latitude. If provided, lng is required                                                  |
+| lng             | optional - The longitude. If provided, lat is required                                                 |
+| strictBounds    | optional - Returns only places that are strictly within the region defined by location and radius.     |
+| proxyUrl        | optional - This is required if you want to use the hook in a Web based platform. Since we dont use the Google SDK,  the http call will fail because of issues related to CORS unless a proxyUrl is provided                       |
 
 # Exposed properties
 

src/GoogleAutocomplete.tsx

@@ -20,6 +20,16 @@ interface Options {
    */
   debounce?: number;
 
+  /**
+   * Debounce options
+   */
+  debounceOptions?: {
+    maxWait?: number;
+    leading?: boolean;
+    trailing?: boolean;
+    equalityFn?: (left: any, right: any) => boolean;
+  };
+
   /**
    * Language for Google query - default: en
    */
@@ -72,13 +82,14 @@ export const useGoogleAutocomplete = (apiKey: string, opts: Options = {}) => {
   const {
     minLength = 2,
     debounce = 300,
+    debounceOptions = {},
     language = 'en',
     queryTypes = 'address',
   } = opts;
   const isMounted = useIsMounted();
   const [isSearching, setIsSearching] = useState(false);
   const [term, setTerm] = useState('');
-  const [debouncedTerm] = useDebounce(term, debounce);
+  const [debouncedTerm] = useDebounce(term, debounce, debounceOptions);
   const [locationResults, setLocationResults] = useState<
     GoogleLocationResult[]
   >([]);