Options
All
  • Public
  • Public/Protected
  • All
Menu

Module transform

Index

References

Functions Object

References

Renames and re-exports transform

Object Functions

  • transform<T>(object: Collection<T>, iteratee: AccCollectionIteratee<T, any>, accumulator: any): any
  • An alternative to reduce this method transforms object to a new accumulator object which is the result of running each of its own enumerable string keyed properties thru iteratee, with each invocation potentially mutating the accumulator object. If accumulator is not provided, a new object with the same [[Prototype]] will be used. The iteratee is invoked with four arguments: (accumulator, value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

    since

    5.11.0

    see

    reduce, reduceRight

    example
    transform([2, 3, 4], (result, n) => {
    result.push(n *= n)
    return n % 2 == 0
    }, [])
    // => [4, 9]

    transform({ 'a': 1, 'b': 2, 'c': 1 }, (result, value, key) => {
    (result[value] || (result[value] = [])).push(key)
    }, {})
    // => { '1': ['a', 'c'], '2': ['b'] }

    Type parameters

    • T

    Parameters

    • object: Collection<T>

      The object to iterate over.

    • iteratee: AccCollectionIteratee<T, any>

      The function invoked per iteration.

    • accumulator: any

      The custom accumulator value.

    Returns any

    Returns the accumulated value.