@ahoo-wang/fetcher-react 3.3.9 → 3.4.1

package/dist/wow/useQueryState.d.ts

@@ -0,0 +1,72 @@
+import { AutoExecuteCapable } from './types';
+/**
+ * Configuration options for the useQueryState hook
+ * @template Q - The type of the query parameters
+ */
+export interface UseQueryStateOptions<Q> extends AutoExecuteCapable {
+    /** The initial query parameters to be stored and managed */
+    initialQuery: Q;
+    /** Function to execute with the current query parameters. Called when autoExecute is true */
+    execute: (query: Q) => Promise<void>;
+}
+/**
+ * Return type of the useQueryState hook
+ * @template Q - The type of the query parameters
+ */
+export interface UseQueryStateReturn<Q> {
+    /** Function to retrieve the current query parameters */
+    getQuery: () => Q;
+    /** Function to update the query parameters. Triggers execution if autoExecute is true */
+    setQuery: (query: Q) => void;
+}
+/**
+ * A React hook for managing query state with automatic execution capabilities
+ *
+ * This hook provides a centralized way to manage query parameters, including
+ * getting and setting the current query, and optionally automatically executing
+ * queries when the query changes or on component mount.
+ *
+ * @template Q - The type of the query parameters
+ * @param options - Configuration options for the hook
+ * @returns An object containing getQuery and setQuery functions
+ *
+ * @example
+ * ```typescript
+ * interface UserQuery {
+ *   id: string;
+ *   name?: string;
+ * }
+ *
+ * function UserComponent() {
+ *   const executeQuery = async (query: UserQuery) => {
+ *     // Perform query execution logic here
+ *     console.log('Executing query:', query);
+ *   };
+ *
+ *   const { getQuery, setQuery } = useQueryState<UserQuery>({
+ *     initialQuery: { id: '1' },
+ *     autoExecute: true,
+ *     execute: executeQuery,
+ *   });
+ *
+ *   const handleQueryChange = (newQuery: UserQuery) => {
+ *     setQuery(newQuery); // Will automatically execute if autoExecute is true
+ *   };
+ *
+ *   const currentQuery = getQuery(); // Get current query parameters
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => handleQueryChange({ id: '2', name: 'John' })}>
+ *         Update Query
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @throws This hook does not throw exceptions directly, but the execute function
+ * may throw exceptions that should be handled by the caller.
+ */
+export declare function useQueryState<Q>(options: UseQueryStateOptions<Q>): UseQueryStateReturn<Q>;
+//# sourceMappingURL=useQueryState.d.ts.map

package/dist/wow/useQueryState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useQueryState.d.ts","sourceRoot":"","sources":["../../src/wow/useQueryState.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IACjE,4DAA4D;IAC5D,YAAY,EAAE,CAAC,CAAC;IAChB,6FAA6F;IAC7F,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC,CAAC;IAClB,yFAAyF;IACzF,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC/B,mBAAmB,CAAC,CAAC,CAAC,CA0BxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-react",
-  "version": "3.3.9",
+  "version": "3.4.1",
   "description": "React integration for Fetcher HTTP client. Provides React Hooks and components for seamless data fetching with automatic re-rendering and loading states.",
   "keywords": [
     "fetch",
@@ -70,8 +70,8 @@
     "@testing-library/react": "^16.0.0",
     "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
-    "jsdom": "^27.2.0",
-    "@vitejs/plugin-react": "^5.1.1"
+    "jsdom": "^27.3.0",
+    "@vitejs/plugin-react": "^5.1.2"
   },
   "scripts": {
     "build": "vite build",