@ventlio/tanstack-query 0.5.12 → 0.5.14

package/dist/config/bootstrapQueryRequest.d.ts

@@ -1,4 +1,10 @@
 import type { QueryClient } from '@tanstack/react-query';
 import 'url-search-params-polyfill';
 import type { BootstrapConfig } from '../types';
+/**
+ * Bootstrap the query request system with configuration options
+ *
+ * @param queryClient - TanStack Query client instance
+ * @param options - Configuration options
+ */
 export declare const bootstrapQueryRequest: (queryClient: QueryClient, options?: BootstrapConfig) => Promise<void>;

package/dist/config/useEnvironmentVariables.d.ts

@@ -1,2 +1,6 @@
 import type { IConfig } from './config.interface';
+/**
+ * Hook to access environment variables across different frameworks
+ * Supports React (CRA), Next.js, Vite, and React Native
+ */
 export declare const useEnvironmentVariables: () => IConfig;

package/dist/helpers/index.d.ts

@@ -1,2 +1,3 @@
+export { result } from './result';
 export * from './scrollToTop';
 export * from './timeFuncs';

package/dist/helpers/result.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Gets the value at path of object. If the resolved value is a function,
+ * it's invoked with the this binding of its parent object and its result is returned.
+ * Similar to lodash.result functionality.
+ *
+ * @param object - The object to query
+ * @param path - The path of the property to get (supports dot notation)
+ * @param defaultValue - The value returned if the resolved value is undefined
+ * @returns The resolved value
+ *
+ * @example
+ * const obj = { a: { b: { c: 'value' } } };
+ * result(obj, 'a.b.c'); // => 'value'
+ *
+ * @example
+ * const obj = { a: { b: () => 'computed' } };
+ * result(obj, 'a.b'); // => 'computed'
+ *
+ * @example
+ * result({}, 'a.b.c', 'default'); // => 'default'
+ */
+export declare function result<T = any>(object: any, path: string | string[], defaultValue?: T): T | undefined;
+export default result;