Module "xform/flatten-with"

flattenWith

• flattenWith<T>(fn: Fn<T, MaybeIterable<T>>): Transducer<T | Iterable<T>, T>
• flattenWith<T>(fn: Fn<T, MaybeIterable<T>>, src: Iterable<T | Iterable<T>>): IterableIterator<T>

• Transducer. Takes a function fn which will be applied to each input value. If the function returns an ES6 Iterable, the result will be recursively flattened (via same user provided fn). If the function returns null/undefined, the original input value will be used as result.

  remarks

  Also see flatten. If src is given as well, yields iterator of results.

  example

  // custom predicate which converts objects into key/val tuples,
  // returns iterables as is and null for everything else
  const pred = (x) =>
    isPlainObject(x)
      ? pairs(x)
      : isNotStringAndIterable(x)
        ? x
        : null;
  
  [...flattenWith(pred, [{ a: 1, b: 2 }, [[{ c: 3 }]]])]
  // [ 'a', 1, 'b', 2, 'c', 3 ]

  Type parameters

  • T

  Parameters

  • fn: Fn<T, MaybeIterable<T>>

    -

  Returns Transducer<T | Iterable<T>, T>

• Type parameters

  • T

  Parameters

  • fn: Fn<T, MaybeIterable<T>>

  • src: Iterable<T | Iterable<T>>

  Returns IterableIterator<T>