External module "utils/until-each/docs/types/index.d"

Export assignment untilEach

• untilEach<T, U>(collection: Collection<T>, predicate: Predicate<T>, fcn: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>>): Collection<T>

• Until a test condition is true, invokes a function once for each element in a collection.

  Notes

  • When invoked, both the predicate function and the function to apply are provided three arguments:

    • value: collection value
    • index: collection index
    • collection: the input collection

  Type parameters

  • T

  • U

  Parameters

  • collection: Collection<T>

    input collection

  • predicate: Predicate<T>

    function which indicates whether to stop iterating over a collection

  • fcn: Callback<T, U>

    function to invoke

  • Optional thisArg: ThisParameterType<Callback<T, U>>

    execution context for the applied function

  Returns Collection < T >

  input collection

  Example

  function predicate( v, key, collection ) {
      return ( v !== v );
  }
  
  function log( v, key, collection ) {
      console.log( '%s: %d', key, v );
  }
  
  var arr = [ 1, 2, 3, 4, NaN, 5 ];
  
  untilEach( arr, predicate, log );