Flat typedefs

$flat.d.ts

import { $IterableLike, $IterableIterator, $MaybePromise } from './internal/$iterable';

type $MaybeIterable<T> = T extends $IterableLike<infer T> ? $IterableLike<T> : any;

// prettier-ignore
declare function $flat<U = any>(
  depth: 0,
  iterable: $MaybeIterable<U>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 1,
  iterable: $MaybeIterable<$MaybeIterable<U>>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 2,
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 3,
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 4,
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 5,
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 6,
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>>>,
): $IterableIterator<U>;

declare function $flat<U = any>(
  depth: 7,
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>>>>,
): $IterableIterator<U>;


// prettier-ignore
declare function $flat<U = any>(
  depth: 0,
  iterable: $MaybeIterable<U>,
): $IterableIterator<U>;
// prettier-ignore
declare function $flat(
  depth: 1,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<U>>
) => $IterableIterator<U>;
// prettier-ignore
declare function $flat(
  depth: 2,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>
) => $IterableIterator<U>;

declare function $flat(
  depth: 3,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>,
) => $IterableIterator<U>;

declare function $flat(
  depth: 4,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>,
) => $IterableIterator<U>;

declare function $flat(
  depth: 5,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>>,
) => $IterableIterator<U>;

declare function $flat(
  depth: 6,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>>>,
) => $IterableIterator<U>;

declare function $flat(
  depth: 7,
): <U = any>(
  iterable: $MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<$MaybeIterable<U>>>>>>>>,
) => $IterableIterator<U>;

declare function $flat (
  shouldFlat: (item: any) => $MaybePromise<boolean>,
  depth: number,
  iter: $MaybeIterable<any>
): $IterableIterator<any>

declare function $flat(iterable: $MaybeIterable<any>): $IterableIterator<any>;
declare function $flat(depth: number, iterable: $MaybeIterable<any>): $IterableIterator<any>;
declare function $flat(depth?: number): (iterable: $MaybeIterable<any>) => $IterableIterator<any>;

export default $flat;