import type { Function } from "@vangware/types";
import type { IsomorphicGeneratorFunction } from "./types/IsomorphicGeneratorFunction.js";
/**
 * Takes a generator function and returns an iterable iterator or asynchronous
 * iterable iterator object.
 *
 * @category Common
 * @example
 * ```typescript
 * const identityGenerator = function* (value) { yield value; };
 * const iterableIterator = createIterableIterator(identityGenerator);
 *
 * const fooIdentity = iterableIterator("foo");
 *
 * for (const value of fooIdentity) {
 * 	console.log(value); // "foo"
 * }
 *
 * // Same IterableIterator as above, return values again:
 *
 * for (const value of fooIdentity) {
 * 	console.log(value); // "foo"
 * }
 * ```
 * @param generatorFunction Generator to be used every time `[Symbol.iterator]` is called.
 * @returns Iterable iterator object.
 */
export declare const createIterableIterator: <
	GeneratorFunction_1 extends IsomorphicGeneratorFunction,
>(
	generatorFunction: GeneratorFunction_1,
) => GeneratorFunction_1 extends IsomorphicGeneratorFunction<infer Item>
	? GeneratorFunction_1 extends Function<
			never,
			{
				readonly next: (
					...args: [] | [void]
				) => Promise<IteratorResult<Item, void>>;
				readonly return?:
					| ((
							value?: void | PromiseLike<void> | undefined,
					  ) => Promise<IteratorResult<Item, void>>)
					| undefined;
				readonly throw?:
					| ((e?: any) => Promise<IteratorResult<Item, void>>)
					| undefined;
			}
	  >
		? {
				readonly [Symbol.asyncIterator]: () => AsyncIterableIterator<Item>;
				readonly next: (
					...args: [] | [undefined]
				) => Promise<IteratorResult<Item, any>>;
				readonly return?:
					| ((value?: any) => Promise<IteratorResult<Item, any>>)
					| undefined;
				readonly throw?:
					| ((e?: any) => Promise<IteratorResult<Item, any>>)
					| undefined;
		  }
		: {
				readonly [Symbol.iterator]: () => IterableIterator<Item>;
				readonly next: (
					...args: [] | [undefined]
				) => IteratorResult<Item, any>;
				readonly return?:
					| ((value?: any) => IteratorResult<Item, any>)
					| undefined;
				readonly throw?:
					| ((e?: any) => IteratorResult<Item, any>)
					| undefined;
		  }
	: never;