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

Export assignment whileEachRight

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

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

  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

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

  Parameters

  • collection: Collection

    input collection

  • predicate: Predicate

    function which indicates whether to continue iterating over a collection

  • fcn: Callback

    function to invoke

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