feat: make useAsyncIterState iterable's type more accurate (#23)

Author: shtaif

spec/tests/useAsyncIterState.spec.tsx

@@ -39,7 +39,7 @@ describe('`useAsyncIterState` hook', () => {
       const yieldPromise1 = iterator1.next();
       const yieldPromise2 = iterator2.next();
 
-      await iterator1.return!();
+      await iterator1.return();
 
       {
         const promiseStates = await Promise.all(
@@ -51,7 +51,7 @@ describe('`useAsyncIterState` hook', () => {
         ]);
       }
 
-      await iterator2.return!();
+      await iterator2.return();
 
       {
         const promiseStates = await Promise.all(

src/useAsyncIterState/IterableChannel.ts

@@ -18,7 +18,12 @@ class IterableChannel<TVal> {
     this.#nextIteration.resolve({ done: true, value: undefined });
   }
 
-  iterable = {
+  iterable: {
+    [Symbol.asyncIterator](): {
+      next(): Promise<IteratorResult<TVal, void>>;
+      return(): Promise<IteratorReturnResult<void>>;
+    };
+  } = {
     [Symbol.asyncIterator]: () => {
       const whenIteratorClosed = promiseWithResolvers<IteratorReturnResult<undefined>>();
 
@@ -33,5 +38,5 @@ class IterableChannel<TVal> {
         },
       };
     },
-  } satisfies AsyncIterable<TVal, void, void>;
+  };
 }

src/useAsyncIterState/index.ts

@@ -77,4 +77,4 @@ function useAsyncIterState<TVal>(): AsyncIterStateResult<TVal> {
  *
  * @see {@link useAsyncIterState `useAsyncIterState`}
  */
-type AsyncIterStateResult<TVal> = [AsyncIterable<TVal, void, void>, (newValue: TVal) => void];
+type AsyncIterStateResult<TVal> = [IterableChannel<TVal>['iterable'], (newValue: TVal) => void];