iter-tools-es/impls/$forkerate/async-forkerate.d.ts

The iterable toolbox

import { AsyncWrappable, AsyncIteratorResult, AsyncNonIterableIterator } from '../../types/async-iterable';
export interface AsyncForkeratorIterator<T> {
  next(): AsyncIteratorResult<T>;
  return(): AsyncIteratorResult<T>;
  [Symbol.asyncIterator](): AsyncNonIterableIterator<T>;
}
interface AsyncForkeratorBase<T> {
  readonly index: number;
  advance(n?: number): Promise<AsyncForkerator<T>>;
  return(): Promise<AsyncForkerator<T>>;
  fork(): AsyncForkeratorIterator<T>;
  asIterator(): AsyncForkeratorIterator<T>;
  [Symbol.asyncIterator](): AsyncForkeratorIterator<T>;
}
interface AsyncDoneForkerator<T> extends AsyncForkeratorBase<T> {
  readonly current: {
    done: true;
    value: undefined;
  };
  readonly done: true;
  readonly value: undefined;
}
interface AsyncValueForkerator<T> extends AsyncForkeratorBase<T> {
  readonly current: {
    done: false;
    value: T;
  };
  readonly done: false;
  readonly value: T;
}
export type AsyncForkerator<T> = AsyncDoneForkerator<T> | AsyncValueForkerator<T>;
declare function asyncForkerate<T>(source: AsyncWrappable<T>): Promise<AsyncForkerator<T>>;
export { asyncForkerate };