reactjrx 1.33.0 → 1.34.0

package/dist/index.cjs

@@ -459,13 +459,13 @@ function shallowEqual(objA, objB) {
   }
   return true;
 }
-function useMutation(query, mapOperatorOrOptions, options = {}) {
+function useAsyncQuery(query, mapOperatorOrOptions, options = {}) {
   const queryRef = useLiveRef(query);
   const triggerSubject = useSubject();
   const resetSubject = useSubject({
     /**
      * @important
-     * Because mutation can still run after unmount, the user might
+     * Because async query can still run after unmount, the user might
      * want to use reset for whatever reason. We will only manually complete
      * this subject whenever the main query hook finalize.
      */
@@ -860,8 +860,8 @@ exports.getDelay = getDelay;
 exports.retryBackoff = retryBackoff;
 exports.signal = signal;
 exports.trigger = trigger;
+exports.useAsyncQuery = useAsyncQuery;
 exports.useLiveRef = useLiveRef;
-exports.useMutation = useMutation;
 exports.useObserve = useObserve;
 exports.useObserveCallback = useObserveCallback;
 exports.usePersistSignalsContext = usePersistSignalsContext;

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export * from "./lib/state/persistance/createLocalforageAdapter";
 export * from "./lib/utils/useUnmountObservable";
 export * from "./lib/utils/retryBackoff";
 export * from "./lib/utils/useLiveRef";
-export * from "./lib/queries/useMutation";
+export * from "./lib/queries/useAsyncQuery";
 export * from "./lib/queries/useQuery";
 export * from "./lib/queries/useSubscribeEffect";
 export { Provider as ReactjrxQueryProvider } from "./lib/queries/Provider";

package/dist/index.js

@@ -457,13 +457,13 @@ function shallowEqual(objA, objB) {
   }
   return true;
 }
-function useMutation(query, mapOperatorOrOptions, options = {}) {
+function useAsyncQuery(query, mapOperatorOrOptions, options = {}) {
   const queryRef = useLiveRef(query);
   const triggerSubject = useSubject();
   const resetSubject = useSubject({
     /**
      * @important
-     * Because mutation can still run after unmount, the user might
+     * Because async query can still run after unmount, the user might
      * want to use reset for whatever reason. We will only manually complete
      * this subject whenever the main query hook finalize.
      */
@@ -859,8 +859,8 @@ export {
   retryBackoff,
   signal,
   trigger,
+  useAsyncQuery,
   useLiveRef,
-  useMutation,
   useObserve,
   useObserveCallback,
   usePersistSignalsContext,

package/dist/lib/queries/{useMutation.d.ts → useAsyncQuery.d.ts}

@@ -4,22 +4,22 @@ interface QueryState<R> {
     status: "idle" | "loading" | "error" | "success";
     error: unknown;
 }
-export interface MutationOptions<Result, Params> {
+export interface AsyncQueryOptions<Result, Params> {
     retry?: false | number | ((attempt: number, error: unknown) => boolean);
     /**
-     * Called for every mutation on error.
+     * Called for every async query on error.
      * `merge` mapping will run callback as they happen.
      * Use `concat` if you need to run callbacks in order of calling.
      */
     onError?: (error: unknown, params: Params) => void;
     /**
-     * Called for every mutation on success.
+     * Called for every async query on success.
      * `merge` mapping will run callback as they happen.
      * Use `concat` if you need to run callbacks in order of calling.
      */
     onSuccess?: (data: Result, params: Params) => void;
     /**
-     * When true, any running mutation will be cancelled (when possible) on unmount.
+     * When true, any running async query will be cancelled (when possible) on unmount.
      * You need to handle it yourself for promises if needed.
      * Callbacks will not be called as a result.
      *
@@ -39,19 +39,19 @@ interface Result<A, R> {
     status: "idle" | "loading" | "error" | "success";
     isLoading: boolean;
     /**
-     * If the latest mutation is in a success state, data contains its result.
+     * If the latest async query is in a success state, data contains its result.
      *
      * @important
-     * The value does not automatically reset when a new mutation run. It will be updated
-     * when a new mutation success or error.
+     * The value does not automatically reset when a new async query run. It will be updated
+     * when a new async query success or error.
      */
     data: R | undefined;
     /**
-     * If the latest mutation is in a error state, error contains its error.
+     * If the latest async query is in a error state, error contains its error.
      *
      * @important
-     * The value does not automatically reset when a new mutation run. It will be updated
-     * when a new mutation success or error.
+     * The value does not automatically reset when a new async query run. It will be updated
+     * when a new async query success or error.
      */
     error: unknown | undefined;
     mutate: (args: A) => void;
@@ -63,20 +63,20 @@ interface Result<A, R> {
  * it when specific need arise.
  *
  * `merge`:
- * Run each mutation as they are triggered without any cancellation or queue system.
- * The result is always from the latest mutation triggered, not necessarily
+ * Run each async query as they are triggered without any cancellation or queue system.
+ * The result is always from the latest async query triggered, not necessarily
  * the latest one running.
  *
  * `concat`:
- * Unlike merge, it will trigger each mutation sequentially following
- * a queue system. The result is not necessarily the last triggered mutation
- * but the current running mutation.
+ * Unlike merge, it will trigger each async query sequentially following
+ * a queue system. The result is not necessarily the last triggered async query
+ * but the current running async query.
  *
  * `switch`:
- * Only run the latest mutation triggered and cancel any previously running one.
- * Result correspond to the current running mutation.
+ * Only run the latest async query triggered and cancel any previously running one.
+ * Result correspond to the current running async query.
  */
 type MapOperator = "switch" | "concat" | "merge";
-export declare function useMutation<A = void, R = undefined>(query: (args: A) => Promise<R> | Observable<R>, mapOperatorOrOptions?: MapOperator, options?: MutationOptions<R, A>): Result<A, R>;
-export declare function useMutation<A = void, R = undefined>(query: (args: A) => Promise<R> | Observable<R>, mapOperatorOrOptions?: MutationOptions<R, A>): Result<A, R>;
+export declare function useAsyncQuery<A = void, R = undefined>(query: (args: A) => Promise<R> | Observable<R>, mapOperatorOrOptions?: MapOperator, options?: AsyncQueryOptions<R, A>): Result<A, R>;
+export declare function useAsyncQuery<A = void, R = undefined>(query: (args: A) => Promise<R> | Observable<R>, mapOperatorOrOptions?: AsyncQueryOptions<R, A>): Result<A, R>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "reactjrx",
   "private": false,
-  "version": "1.33.0",
+  "version": "1.34.0",
   "type": "module",
   "files": [
     "dist"