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

Export assignment doUntilEach

• doUntilEach(collection: Collection, fcn: Callback, predicate: Predicate, thisArg?: any): Collection

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

  Notes

  • The condition is evaluated after executing the function to invoke; thus, the provided function always executes at least once.

  • 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

  • If provided an empty collection, the function invokes the provided function with the collection index set to undefined.

  Parameters

  • collection: Collection

    input collection

  • fcn: Callback

    function to invoke

  • predicate: Predicate

    function which indicates whether to stop iterating over a collection

  • Optional thisArg: any

    execution context for the applied function

  Returns Collection

  input collection

  Example

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