Skip to content

Internal refactor for useAsyncIterMulti and useAsyncItersImperatively #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 60 additions & 9 deletions src/common/useAsyncItersImperatively/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { useEffect } from 'react';
import { type IterationResult } from '../../useAsyncIter/index.js';
import { type AsyncIterableSubject } from '../../AsyncIterableSubject/index.js';
import { type IterationResultSet } from '../../useAsyncIterMulti/index.js';
import { type Writable } from '../Writable.js';
import { useRefWithInitialValue } from '../hooks/useRefWithInitialValue.js';
import { isAsyncIter } from '../isAsyncIter.js';
Expand All @@ -12,28 +11,69 @@ import { iterateAsyncIterWithCallbacks } from '../iterateAsyncIterWithCallbacks.

export { useAsyncItersImperatively, type IterationResultSet };

// TODO: Move the `IterationResultSet` type's home to sit together with this function here instead next to `useAsyncIterMulti` as currently

function useAsyncItersImperatively<
const useAsyncItersImperatively: {
<const TInputs extends readonly unknown[]>(
inputs: TInputs,
onYieldCb: (vals: IterationResultSet<TInputs>) => void,
opts?: {
initialValues?: undefined;
defaultInitialValue?: undefined;
}
): IterationResultSet<TInputs>;

<
const TInputs extends readonly unknown[],
const TInitVals extends readonly unknown[] = readonly [],
>(
inputs: TInputs,
onYieldCb: (vals: IterationResultSet<TInputs>) => void,
opts: {
initialValues: TInitVals;
defaultInitialValue?: undefined;
}
): IterationResultSet<TInputs, TInitVals>;

<const TInputs extends readonly unknown[], const TDefaultInitValue = undefined>(
inputs: TInputs,
onYieldCb: (vals: IterationResultSet<TInputs>) => void,
opts: {
initialValues?: undefined;
defaultInitialValue: TDefaultInitValue;
}
): IterationResultSet<TInputs, [], TDefaultInitValue>;

<
const TInputs extends readonly unknown[],
const TInitVals extends readonly unknown[] = readonly [],
const TDefaultInitValue = undefined,
>(
inputs: TInputs,
onYieldCb: (vals: IterationResultSet<TInputs>) => void,
opts: {
initialValues: TInitVals;
defaultInitialValue: TDefaultInitValue;
}
): IterationResultSet<TInputs, TInitVals, TDefaultInitValue>;
} = <
const TInputs extends readonly unknown[],
const TInitVals extends readonly unknown[] = readonly [],
const TDefaultInitValue = undefined,
>(
inputs: TInputs,
onYieldCb: (vals: IterationResultSet<TInputs>) => void,
onYieldCb: (vals: IterationResultSet<TInputs, TInitVals, TDefaultInitValue>) => void,
opts?: {
initialValues?: TInitVals;
defaultInitialValue?: TDefaultInitValue;
}
): IterationResultSet<TInputs> {
): IterationResultSet<TInputs, TInitVals, TDefaultInitValue> => {
const optsNormed = {
initialValues: opts?.initialValues ?? [],
defaultInitialValue: opts?.defaultInitialValue,
};

const ref = useRefWithInitialValue(() => ({
currDiffCompId: 0,
currResults: [] as IterationResultSet<TInputs>,
currResults: [] as IterationResultSet<TInputs, TInitVals, TDefaultInitValue>,
activeItersMap: new Map<
AsyncIterable<unknown>,
{
Expand Down Expand Up @@ -130,7 +170,7 @@ function useAsyncItersImperatively<
activeItersMap.set(baseIter, iterState);

return iterState.currState;
}) as Writable<IterationResultSet<TInputs>>;
}) as Writable<IterationResultSet<TInputs, TInitVals, TDefaultInitValue>>;

// TODO: If the consumers of `useAsyncItersImperatively` within the library are intending to use it in conjunction with `React.useEffect` (e.g. `useAsyncIterEffect`) - do we really need to do such individual length comparisons and cleanups like the following? `React.useEffect` enforces strict static-length deps anyways
const numOfPrevRunItersDisappeared = numOfPrevRunIters - numOfPrevRunItersPreserved;
Expand All @@ -149,4 +189,15 @@ function useAsyncItersImperatively<
}

return ref.current.currResults;
}
};

type IterationResultSet<
TValues extends readonly unknown[],
TInitValues extends readonly unknown[] = readonly [],
TDefaultInitValue = undefined,
> = {
[I in keyof TValues]: IterationResult<
TValues[I],
I extends keyof TInitValues ? TInitValues[I] : TDefaultInitValue
>;
};
35 changes: 8 additions & 27 deletions src/useAsyncIterMulti/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { useSimpleRerender } from '../common/hooks/useSimpleRerender.js';
import { type IterationResult } from '../useAsyncIter/index.js';
import { type MaybeFunction } from '../common/MaybeFunction.js';
import { useAsyncItersImperatively } from '../common/useAsyncItersImperatively/index.js';
import {
useAsyncItersImperatively,
type IterationResultSet,
} from '../common/useAsyncItersImperatively/index.js';

export { useAsyncIterMulti, type IterationResult, type IterationResultSet };

Expand Down Expand Up @@ -201,34 +203,13 @@ function useAsyncIterMulti<
initialValues?: TInitValues;
defaultInitialValue?: TDefaultInitValue;
}
): IterationResultSet<TValues, MaybeFunctions<TInitValues>, TDefaultInitValue> {
): IterationResultSet<TValues, TInitValues, TDefaultInitValue> {
const update = useSimpleRerender();

const currValues = useAsyncItersImperatively(inputs, () => update(), {
initialValues: opts?.initialValues ?? [],
defaultInitialValue: opts?.defaultInitialValue,
initialValues: (opts?.initialValues ?? []) as TInitValues,
defaultInitialValue: opts?.defaultInitialValue as TDefaultInitValue,
});

const currValuesTypePatched = currValues as IterationResultSet<
TValues,
MaybeFunctions<TInitValues>,
TDefaultInitValue
>;

return currValuesTypePatched;
return currValues;
}

type IterationResultSet<
TValues extends readonly unknown[],
TInitValues extends readonly unknown[] = readonly [],
TDefaultInitValue = undefined,
> = {
[I in keyof TValues]: IterationResult<
TValues[I],
I extends keyof TInitValues ? TInitValues[I] : TDefaultInitValue
>;
};

type MaybeFunctions<T extends readonly unknown[]> = {
[I in keyof T]: T[I] extends MaybeFunction<infer J> ? J : T[I];
};