Various misc refactorings

spec/tests/Iterate.spec.tsx

@@ -2,7 +2,7 @@ import { it, describe, expect, afterEach, vi } from 'vitest';
 import { gray } from 'colorette';
 import { render, cleanup as cleanupMountedReactTrees, act } from '@testing-library/react';
 import { Iterate, It, type IterationResult } from '../../src/index.js';
-import { IterableChannelTestHelper } from '../utils/IterableChannelTestHelper.js';
+import { IteratorChannelTestHelper } from '../utils/IteratorChannelTestHelper.js';
 
 afterEach(() => {
   cleanupMountedReactTrees();
@@ -18,7 +18,7 @@ describe('`Iterate` component', () => {
       'When used in the no-render-function form and given an iterable that yields a value will render correctly'
     ),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const rendered = render(<Iterate>{channel}</Iterate>);
 
@@ -47,7 +47,7 @@ describe('`Iterate` component', () => {
       'When used in the no-render-function form and given an iterable that yields a value in conjunction with some initial value will render correctly'
     ),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const rendered = render(<Iterate initialValue="_">{channel}</Iterate>);
 
@@ -136,7 +136,7 @@ describe('`Iterate` component', () => {
   );
 
   it(gray('When given an iterable that yields a value will render correctly'), async () => {
-    const channel = new IterableChannelTestHelper<string>();
+    const channel = new IteratorChannelTestHelper<string>();
     let timesRerendered = 0;
     let lastRenderFnInput: undefined | IterationResult<string | undefined>;
 
@@ -180,7 +180,7 @@ describe('`Iterate` component', () => {
       'When given an iterable that yields a value in conjunction with some initial value will render correctly'
     ),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
       let timesRerendered = 0;
       let lastRenderFnInput: undefined | IterationResult<string>;
 
@@ -221,7 +221,7 @@ describe('`Iterate` component', () => {
   );
 
   it(gray('When given an iterable that yields multiple values will render correctly'), async () => {
-    const channel = new IterableChannelTestHelper<string>();
+    const channel = new IteratorChannelTestHelper<string>();
     let timesRerendered = 0;
     let lastRenderFnInput: undefined | IterationResult<string | undefined>;
 
@@ -331,7 +331,7 @@ describe('`Iterate` component', () => {
   it(
     gray('When given an iterable that yields a value and then completes will render correctly'),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
       let timesRerendered = 0;
       let lastRenderFnInput: undefined | IterationResult<string | undefined>;
 
@@ -446,7 +446,7 @@ describe('`Iterate` component', () => {
   it(
     gray('When given an iterable that yields a value and then errors will render correctly'),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
       let timesRerendered = 0;
       let lastRenderFnInput: undefined | IterationResult<string | undefined>;
 
@@ -498,8 +498,8 @@ describe('`Iterate` component', () => {
       let lastRenderFnInput: undefined | IterationResult<string | undefined>;
 
       const [channel1, channel2] = [
-        new IterableChannelTestHelper<string>(),
-        new IterableChannelTestHelper<string>(),
+        new IteratorChannelTestHelper<string>(),
+        new IteratorChannelTestHelper<string>(),
       ];
 
       const [channelReturnSpy1, channelReturnSpy2] = [
@@ -587,7 +587,7 @@ describe('`Iterate` component', () => {
   it(gray('When unmounted will close the last active iterator it held'), async () => {
     let lastRenderFnInput: undefined | IterationResult<string | undefined>;
 
-    const channel = new IterableChannelTestHelper<string>();
+    const channel = new IteratorChannelTestHelper<string>();
     const channelReturnSpy = vi.spyOn(channel, 'return');
 
     const buildTestContent = (value: AsyncIterable<string>) => {
@@ -675,7 +675,7 @@ describe('`Iterate` component', () => {
     async () => {
       let timesRerendered = 0;
       let lastRenderFnInput: undefined | IterationResult<string | undefined>;
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const rendered = render(
         <Iterate value={channel}>

spec/tests/iterateFormatted.spec.tsx

@@ -4,7 +4,7 @@ import { render, cleanup as cleanupMountedReactTrees, act } from '@testing-libra
 import { iterateFormatted, Iterate } from '../../src/index.js';
 import { pipe } from '../utils/pipe.js';
 import { asyncIterToArray } from '../utils/asyncIterToArray.js';
-import { IterableChannelTestHelper } from '../utils/IterableChannelTestHelper.js';
+import { IteratorChannelTestHelper } from '../utils/IteratorChannelTestHelper.js';
 
 afterEach(() => {
   cleanupMountedReactTrees();
@@ -50,7 +50,7 @@ describe('`iterateFormatted` function', () => {
       'When the wrapped source is used normally with library tools it is rendered and formatted correctly'
     ),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const rendered = render(
         <Iterate
@@ -81,8 +81,8 @@ describe('`iterateFormatted` function', () => {
     ),
     async () => {
       const [channel1, channel2] = [
-        new IterableChannelTestHelper<string>(),
-        new IterableChannelTestHelper<string>(),
+        new IteratorChannelTestHelper<string>(),
+        new IteratorChannelTestHelper<string>(),
       ];
 
       const [channelReturnSpy1, channelReturnSpy2] = [
@@ -124,7 +124,7 @@ describe('`iterateFormatted` function', () => {
       'Always the latest closure passed in as the format function will be the one to format the next-arriving source value'
     ),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const Wrapper = (props: { outerValue: string }) => (
         <Iterate

spec/tests/useAsyncIter.spec.ts

@@ -2,7 +2,7 @@ import { it, describe, expect, afterEach, vi } from 'vitest';
 import { gray } from 'colorette';
 import { cleanup as cleanupMountedReactTrees, act, renderHook } from '@testing-library/react';
 import { useAsyncIter } from '../../src/index.js';
-import { IterableChannelTestHelper } from '../utils/IterableChannelTestHelper.js';
+import { IteratorChannelTestHelper } from '../utils/IteratorChannelTestHelper.js';
 
 afterEach(() => {
   cleanupMountedReactTrees();
@@ -75,7 +75,7 @@ describe('`useAsyncIter` hook', () => {
   );
 
   it(gray('When given an iterable that yields a value will return correct results'), async () => {
-    const channel = new IterableChannelTestHelper<string>();
+    const channel = new IteratorChannelTestHelper<string>();
 
     const renderedHook = renderHook(() => useAsyncIter(channel));
 
@@ -101,7 +101,7 @@ describe('`useAsyncIter` hook', () => {
       'When given an iterable that yields a value in conjunction with some initial value will return correct results'
     ),
     async () => {
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const renderedHook = renderHook(() => useAsyncIter(channel, '_'));
 
@@ -127,7 +127,7 @@ describe('`useAsyncIter` hook', () => {
     gray('When given an iterable that yields multiple values will return correct results'),
     async () => {
       let timesRerendered = 0;
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const renderedHook = renderHook(() => {
         timesRerendered++;
@@ -211,7 +211,7 @@ describe('`useAsyncIter` hook', () => {
     ),
     async () => {
       let timesRerendered = 0;
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const renderedHook = renderHook(() => {
         timesRerendered++;
@@ -298,7 +298,7 @@ describe('`useAsyncIter` hook', () => {
     gray('When given an iterable that yields a value and then errors will return correct results'),
     async () => {
       let timesRerendered = 0;
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
       const simulatedErr = new Error('...');
 
       const renderedHook = renderHook(() => {
@@ -334,8 +334,8 @@ describe('`useAsyncIter` hook', () => {
     ),
     async () => {
       const [channel1, channel2] = [
-        new IterableChannelTestHelper<string>(),
-        new IterableChannelTestHelper<string>(),
+        new IteratorChannelTestHelper<string>(),
+        new IteratorChannelTestHelper<string>(),
       ];
 
       const [channelReturnSpy1, channelReturnSpy2] = [
@@ -409,7 +409,7 @@ describe('`useAsyncIter` hook', () => {
   );
 
   it(gray('When unmounted will close the last active iterator it held'), async () => {
-    const channel = new IterableChannelTestHelper<string>();
+    const channel = new IteratorChannelTestHelper<string>();
     const channelReturnSpy = vi.spyOn(channel, 'return');
 
     const renderedHook = renderHook(({ value }) => useAsyncIter(value), {
@@ -478,7 +478,7 @@ describe('`useAsyncIter` hook', () => {
     ),
     async () => {
       let timesRerendered = 0;
-      const channel = new IterableChannelTestHelper<string>();
+      const channel = new IteratorChannelTestHelper<string>();
 
       const renderedHook = renderHook(() => {
         timesRerendered++;

spec/utils/IterableChannelTestHelper.ts → spec/utils/IteratorChannelTestHelper.ts

@@ -1,6 +1,6 @@
-export { IterableChannelTestHelper };
+export { IteratorChannelTestHelper };
 
-class IterableChannelTestHelper<T> implements AsyncIterableIterator<T>, AsyncDisposable {
+class IteratorChannelTestHelper<T> implements AsyncIterableIterator<T>, AsyncDisposable {
   #isChannelClosed = false;
   #nextIteration = Promise.withResolvers<IteratorResult<T>>();
 

spec/utils/asyncIterTake.ts

@@ -2,6 +2,15 @@ export { asyncIterTake };
 
 function asyncIterTake<T>(count: number): (src: AsyncIterable<T>) => AsyncIterable<T> {
   return sourceIter => {
+    if (count === 0) {
+      return {
+        [Symbol.asyncIterator]: () => ({
+          next: async () => ({ done: true, value: undefined }),
+          return: async () => ({ done: true, value: undefined }),
+        }),
+      };
+    }
+
     let iterator: AsyncIterator<T>;
     let remainingCount = count;
     let closed = false;

spec/utils/pipe.ts

@@ -1,10 +1,6 @@
 export { pipe };
 
-const pipe: PipeFunction = (initVal: unknown, ...funcs: ((...args: any[]) => any)[]) => {
-  return funcs.reduce((currVal, nextFunc) => nextFunc(currVal), initVal);
-};
-
-interface PipeFunction {
+const pipe: {
   <const TInitVal>(initVal: TInitVal): TInitVal;
 
   <const TInitVal, A>(initVal: TInitVal, ...funcs: [(arg: TInitVal) => A]): A;
@@ -95,4 +91,6 @@ interface PipeFunction {
       (arg: I) => J,
     ]
   ): J;
-}
+} = (initVal: unknown, ...funcs: ((...args: unknown[]) => unknown)[]) => {
+  return funcs.reduce((currVal, fn) => fn(currVal), initVal);
+};

src/useAsyncIterState/IterableChannel.ts

@@ -34,7 +34,7 @@ class IterableChannel<TVal> {
 
         return: async () => {
           whenIteratorClosed.resolve({ done: true, value: undefined });
-          return { done: true as const, value: undefined };
+          return { done: true, value: undefined };
         },
       };
     },