@bigbinary/neeto-commons-frontend 2.1.7 → 2.1.9

package/react-utils.d.ts

@@ -4,6 +4,7 @@ import { Notice } from "@honeybadger-io/js/dist/server/types/core/types";
 import { History } from "history";
 import { StoreApi, UseBoundStore } from "zustand";
 import { UseQueryOptions, UseQueryResult, UseMutationOptions, UseMutationResult } from "react-query";
+import { qsOptionsType, QueryParamsType } from "./utils";
 /**
  *
  * The HoneybadgerErrorBoundary is an ErrorBoundary which reports frontend errors
@@ -1374,4 +1375,22 @@ export const withT: <Props extends {
 */
 export function useMutationWithInvalidation(mutationFn: () => Promise<T>, options: {
   keysToInvalidate: Array<string | string[] | (() => string | string[])>;
-} & UseMutationOptions): UseMutationResult<T>;
+} & UseMutationOptions): UseMutationResult<T>;
+/**
+ *
+ * The useQueryParams hook can be used to retrieve the query parameters whenever
+ *
+ * the location changes. A change in location will trigger rerender when using this
+ *
+ * hook.
+ *
+ * This hook will return an object containing all the query parameters. It will
+ *
+ * return an empty object if no query parameters are present.
+ *
+ * @example 
+ *
+ * const queryParams = useQueryParams();
+ * @endexample
+*/
+export function useQueryParams(options?: qsOptionsType): QueryParamsType;