iteragain
Version:
Javascript Iterable/Iterator/Generator-function utilities.
18 lines • 937 B
TypeScript
import type { IterSource, Iteratee, IteratorOrIterable } from './types';
/**
* Maps the input iterator to a new value `R` and flattens any resulting iterables or iterators by a depth of 1.
* Behaves the same as `Array.prototype.flatMap`.
*
* **Strings returned from `iteratee` are not flattened** into characters. Return an array (e.g. `[...str]`) when you
* want character-level results.
*
* @example
* ```js
* [...flatMap(['123'], str => str)]; // ['123']
* [...flatMap(['123'], str => [...str])]; // ['1', '2', '3']
* ```
*/
export declare function flatMap<T extends IteratorOrIterable<unknown>, R>(arg: T, iteratee: Iteratee<IterSource<T>, R | IteratorOrIterable<R>>): IterableIterator<R>;
export declare function flatMap<T extends IteratorOrIterable<unknown>, R>(iteratee: Iteratee<IterSource<T>, R | IteratorOrIterable<R>>): (arg: T) => IterableIterator<R>;
export default flatMap;
//# sourceMappingURL=flatMap.d.ts.map