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

Export assignment doUntilEachRight

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

• Until a test condition is true, invokes a function once for each element in a collection, iterating from right to left.

  Notes

  • For dynamic array resizing, the only behavior made intentionally consistent with doUntilEach (iterating from left to right) is when elements are pushed onto the beginning (end) of an array. In other words, for doUntilEach(), [].push() behavior is consistent with doUntilEachRight() [].unshift() behavior.

  • 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.

  Type parameters

  • T

  • U

  Parameters

  • collection: Collection<T>

    input collection

  • fcn: Callback<T, U>

    function to invoke

  • predicate: Predicate<T>

    function which indicates whether to stop iterating over a collection

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

    execution context for the applied function

  Returns Collection < T >

  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, NaN, 2, 3, 4, 5 ];
  
  doUntilEachRight( arr, log, predicate );