✅ add tests to useAsyncTask

Author: VitorLuizC

src/index.ts

@@ -1,4 +1,6 @@
 export { default as useAsyncTaskLazy } from './useAsyncTaskLazy';
-export { default as useImmediateAsyncTask } from './hooks/useImmediateAsyncTask';
+export { default as useAsyncTask } from './useAsyncTask/useAsyncTask';
+export type { AsyncTaskResult as ImmediateAsyncTask } from './useAsyncTask/useAsyncTask';
+export type { default as AsyncTask } from './AsyncTask';
+export type { default as AsyncTaskParams } from './AsyncTaskParams';
 export type { AsyncTaskLazyResult } from './useAsyncTaskLazy';
-export type { ImmediateAsyncTask } from './hooks/useImmediateAsyncTask';

src/useAsyncTask/index.ts

@@ -0,0 +1,2 @@
+export { default } from './useAsyncTask';
+export type { AsyncTaskResult } from './useAsyncTask';

src/useAsyncTask/useAsyncTask.test.ts

@@ -0,0 +1,25 @@
+/** @jest-environment jsdom */
+
+import { act, renderHook } from '@testing-library/react';
+import useAsyncTask from './useAsyncTask';
+
+describe('useAsyncTask | integration tests', () => {
+  it('executes immediatly the task', async () => {
+    const task = jest.fn(() => Promise.resolve(10));
+
+    const { result } = renderHook(() => useAsyncTask(task));
+
+    expect(result.current.result).toBe(null);
+    expect(result.current.pending).toBe(true);
+
+    expect(task).toHaveBeenCalledTimes(1);
+
+    expect(result.current.result).toBe(null);
+    expect(result.current.pending).toBe(true);
+
+    await act(() => Promise.resolve());
+
+    expect(result.current.result).toBe(10);
+    expect(result.current.pending).toBe(false);
+  });
+});

src/hooks/useImmediateAsyncTask.ts src/useAsyncTask/useAsyncTask.tssrc/hooks/useImmediateAsyncTask.ts renamed to src/useAsyncTask/useAsyncTask.ts

@@ -2,26 +2,23 @@ import { useLayoutEffect, useRef } from 'react';
 import useLazyAsyncTask from '../useAsyncTaskLazy';
 import type AsyncTask from '../AsyncTask';
 
-export type ImmediateAsyncTask<Result> = Readonly<{
+export type AsyncTaskResult<Result> = Readonly<{
   error: Error | null;
   result: Result | null;
   pending: boolean;
 }>;
 
-function useImmediateAsyncTask<Result>(
+function useAsyncTask<Result>(
   task: AsyncTask<Result>,
-): ImmediateAsyncTask<Result> {
+): AsyncTaskResult<Result> {
   const firstRenderRef = useRef(true);
 
   const { error, result, pending, executeAsyncTask } =
     useLazyAsyncTask<Result>();
 
   useLayoutEffect(() => {
+    firstRenderRef.current = false;
     executeAsyncTask(task);
-
-    return () => {
-      firstRenderRef.current = false;
-    };
   }, [task, executeAsyncTask]);
 
   return {
@@ -31,4 +28,4 @@ function useImmediateAsyncTask<Result>(
   };
 }
 
-export default useImmediateAsyncTask;
+export default useAsyncTask;

src/useAsyncTaskLazy/isAbortError.test.ts

@@ -1,6 +1,6 @@
 /** @jest-environment jsdom */
 
-import isAbortError from '../isAbortError';
+import isAbortError from './isAbortError';
 
 describe('isAbortError | unit tests', () => {
   describe("when environment doesn't support DOMException", () => {