import type { IsomorphicIterable } from "@vangware/types";
/**
 * Takes a value, iterable or asynchronous iterable and yields it.
 *
 * @category Generators
 * @example
 * ```typescript
 * const iterable = toIterable(1);
 * const iterator = getIterator(iterable);
 * iterator.next(); // { value: 1, done: false }
 * iterator.next(); // { value: undefined, done: true }
 * ```
 * @see {@link createIterableIterator}
 * @see {@link ReadOnlyAsyncIterable}
 * @see {@link ReadOnlyAsyncIterableIterator}
 * @see {@link ReadOnlyIterableIterator}
 *
 * @template ValueOrIterable Generic of value or iterable to yield.
 * @param valueOrIterable Vale or iterable to yield.
 * @returns Yielded item or iterable.
 */
export declare const toIterable: <const ValueOrIterable>(
	valueOrIterable: ValueOrIterable,
) => ValueOrIterable extends IsomorphicIterable<infer Item>
	? Item extends {
			readonly [Symbol.asyncIterator]: () => AsyncIterator<
				Item,
				any,
				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;
		  }
	: {
			readonly [Symbol.iterator]: () => IterableIterator<ValueOrIterable>;
			readonly next: (
				...args: [] | [undefined]
			) => IteratorResult<ValueOrIterable, any>;
			readonly return?:
				| ((value?: any) => IteratorResult<ValueOrIterable, any>)
				| undefined;
			readonly throw?:
				| ((e?: any) => IteratorResult<ValueOrIterable, any>)
				| undefined;
	  };