try skip overload

Author: ianmacartney

npm-packages/convex/src/browser/query_options.ts

@@ -22,6 +22,6 @@ export type QueryOptions<Query extends FunctionReference<"query">> = {
 // This helper helps more once we have more inference happening.
 export function convexQueryOptions<Query extends FunctionReference<"query">>(
   options: QueryOptions<Query>,
-) {
+): QueryOptions<Query> {
   return options;
 }

npm-packages/convex/src/react/client.ts

@@ -649,20 +649,26 @@ export type OptionalRestArgsOrSkip<FuncRef extends FunctionReference<any>> =
  *
  * @public
  */
-export type UseQueryOptions<Query extends FunctionReference<"query">> =
-  QueryOptions<Query> & {
-    /**
-     * Whether to throw an error if the query fails.
-     * If false, the error will be returned in the `error` field.
-     * @defaultValue false
-     */
-    throwOnError?: boolean;
-    /**
-     * An initial value to use before the query result is available.
-     * @defaultValue undefined
-     */
-    initialValue?: Query["_returnType"];
-  };
+export type UseQueryOptions<Query extends FunctionReference<"query">> = (
+  | (QueryOptions<Query> & { skip?: false })
+  | {
+      query: Query;
+      args?: NoInfer<unknown>;
+      skip: true;
+    }
+) & {
+  /**
+   * Whether to throw an error if the query fails.
+   * If false, the error will be returned in the `error` field.
+   * @defaultValue false
+   */
+  throwOnError?: boolean;
+  /**
+   * An initial value to use before the query result is available.
+   * @defaultValue undefined
+   */
+  initialValue?: Query["_returnType"];
+};
 
 /**
  * Options for the object-based {@link useQuery} overload with a preloaded query.
@@ -782,7 +788,9 @@ export function useQuery<Query extends FunctionReference<"query">>(
         typeof query === "string"
           ? (makeFunctionReference<"query", any, any>(query) as Query)
           : query;
-      argsObject = queryOrOptions.args ?? ({} as Record<string, Value>);
+      if (!queryOrOptions.skip && queryOrOptions.args) {
+        argsObject = queryOrOptions.args;
+      }
       throwOnError = queryOrOptions.throwOnError ?? false;
       initialValue = queryOrOptions.initialValue;
     }

npm-packages/convex/src/react/use_query.test.ts

@@ -86,6 +86,12 @@ describe("useQuery types", () => {
       args: { _arg: "asdf" },
     });
 
+    useQuery({
+      query: api.module.args,
+      args: { anyarg: 0 },
+      skip: true,
+    });
+
     useQuery({
       query: api.module.args,
       args: { _arg: "asdf" },